/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
+++ /dev/null
-=head1 NAME
-
-vos_backupsys - Creates a backup volume for several read/write volumes
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos backupsys> S<<< [B<-prefix> <I<common prefix on volume(s)>>+] >>>
- S<<< [B<-server> <I<machine name>>] >>>
- S<<< [B<-partition> <I<partition name>>] >>>
- [B<-exclude>] S<<< [B<-xprefix> <I<negative prefix on volume(s)>>+] >>>
- [B<-dryrun>] 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 backups> S<<< [B<-pr> <I<common prefix on volume(s)>>+] >>>
- S<<< [B<-s> <I<machine name>>] >>> S<<< [B<-pa> <I<partition name>>] >>>
- [B<-ex>] S<<< [B<-x> <I<negative prefix on volume(s)>>+] >>> [B<-d>]
- S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>] [B<-v>]
- [B<-en>] [B<-nor>]
- S<<< [B<-co> <I<config directory>>] >>>
- [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos backupsys> command clones each indicated read/write volume to
-create a backup version, placing each clone at the same site as its
-read/write source version. It assigns each clone the same name as the
-read/write source, adding a C<.backup> extension. It assigns the volume ID
-number already allocated for the backup version in the Volume Location
-Database (VLDB). If a backup version already exists for a given volume,
-the new clone replaces it.
-
-To clone every read/write volume listed in the VLDB, omit all of the
-command's options. Otherwise, combine the command's options to clone
-various groups of volumes. The options use one of two basic criteria to
-select volumes: location (the B<-server> and B<-partition> arguments) or
-presence in the volume name of one of a set of specified character strings
-(the B<-prefix>, B<-exclude>, and B<-xprefix> options).
-
-To clone only volumes that reside on one file server machine, include the
-B<-server> argument. To clone only volumes that reside on one partition,
-combine the B<-server> and B<-partition> arguments. The B<-partition>
-argument can also be used alone to clone volumes that reside on the
-indicated partition on every file server machine. These arguments can be
-combined with those that select volumes based on their names.
-
-Combine the B<-prefix>, -exclude, and B<-xprefix> options (with or without
-the B<-server> and B<-partition> arguments) in the indicated ways to
-select volumes based on character strings contained in their names:
-
-=over 4
-
-=item *
-
-To clone every read/write volume at the specified location whose name
-includes one of a set of specified character strings (for example, begins
-with C<user.> or includes the string C<afs>), use the B<-prefix> argument
-or combine the B<-xprefix> and B<-exclude> options.
-
-=item *
-
-To clone every read/write volume at the specified location except those
-whose name includes one of a set of specified character strings, use the
-B<-xprefix> argument or combine the B<-prefix> and B<-exclude> options.
-
-=item *
-
-To clone every read/write volume at the specified location whose name
-includes one of one of a set of specified character strings, except those
-whose names include one of a different set of specified character strings,
-combine the B<-prefix> and B<-xprefix> arguments. The command creates a
-list of all volumes that match the B<-prefix> argument and then removes
-from the list the volumes that match the B<-xprefix> argument. For
-effective results, the strings specified by the B<-xprefix> argument must
-designate a subset of the volumes specified by the B<-prefix> argument.
-
-If the B<-exclude> flag is combined with the B<-prefix> and B<-xprefix>
-arguments, the command creates a list of all volumes that do not match the
-B<-prefix> argument and then adds to the list any volumes that match the
-B<-xprefix> argument. As when the B<-exclude> flag is not used, the result
-is effective only if the strings specified by the B<-xprefix> argument
-designate a subset of the volumes specified by the B<-prefix> argument.
-
-=back
-
-The B<-prefix> and B<-xprefix> arguments both accept multiple values,
-which can be used to define disjoint groups of volumes. Each value can be
-one of two types:
-
-=over 4
-
-=item *
-
-A simple character string, which matches volumes whose name begin with the
-string. All characters are interpreted literally (that is, characters that
-potentially have special meaning to the command shell, such as the period,
-have only their literal meaning).
-
-=item *
-
-A regular expression, which matches volumes whose names contain the
-expressions. Place a caret (C<^>) at the beginning of the expression, and
-enclose the entire string in single quotes (C<''>). Explaining regular
-expressions is outside the scope of this reference page; see the UNIX
-manual page for regexp(5) or (for a brief introduction)
-L<backup_addvolentry(8)>. As an example, the following expression matches
-volumes that have the string C<aix> anywhere in their names:
-
- -prefix '^.*aix'
-
-=back
-
-To display a list of the volumes to be cloned, without actually cloning
-them, include the B<-dryrun> flag. To display a statement that summarizes
-the criteria being used to select volume, include the B<-verbose> flag.
-
-This command can be used to clone a single read/write volume; specify its
-complete name as the B<-prefix> argument. However, it is more efficient to
-use the B<vos backup> command, which employs a more streamlined technique
-for finding a single volume.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-prefix> <I<common prefix>>
-
-Specifies one or more simple character strings or regular expressions of
-any length; a volume whose name includes the string is placed on the set
-of volumes to be cloned. Include field separators (such as periods) if
-appropriate. This argument can be combined with any combination of the
-B<-server>, B<-partition>, B<-exclude>, and B<-xprefix> options.
-
-=item B<-server> <I<machine name>>
-
-Identifies the file server machine where each read/write source 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)>.
-
-This argument can be combined with any combination of the B<-prefix>,
-B<-partition>, B<-exclude>, and B<-xprefix> options.
-
-=item B<-partition> <I<partition name>>
-
-Identifies the partition where each read/write source volume
-resides. 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)>.
-
-This argument can be combined with any combination of the B<-prefix>,
-B<-server>, B<-exclude>, and B<-xprefix> options.
-
-=item B<-exclude>
-
-Reverses the meaning of the B<-prefix> or B<-xprefix> argument. This flag
-can be combined with any combination of the B<-prefix>, B<-server>,
-B<-partition>, and B<-xprefix> options.
-
-=item B<-xprefix> <I<negative prefix>>
-
-Specifies a simple character string or regular expression of any length; a
-volume whose name includes the string is removed from the set of volumes
-to be cloned. Include field separators (such as periods) if
-appropriate. This argument can be combined with any combination of the
-B<-prefix>, B<-server>, B<-partition>, and B<-exclude> options.
-
-=item B<-dryrun>
-
-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.
-
-=back
-
-=head1 OUTPUT
-
-The command generates the following messages on the standard output stream
-to confirm that the operation was successful:
-
- done
- Total volumes backed up: <number_cloned>; failed to backup: <failures>
-
-If the B<-dryrun> flag is included, a list of the volumes to be backed up
-precedes the standard confirmation messages.
-
-If the B<-verbose> flag is included but not the B<-dryrun> flag, the
-following messages appear for each volume. The output concludes with the
-standard confirmation messages.
-
- Creating backup volume for <volume_name> on <date/time>
- {Recloning backup volume | Creating a new backup clone} <backup_volumeID> . . .done
-
-If both the B<-dryrun> and B<-verbose> flags are included, the output
-begins with a statement summarizing the criteria being used to select the
-volumes, followed by a list of the volumes and the standard confirmation
-messages. The format of the criteria summary statement depends on which
-other options are provided:
-
-=over 4
-
-=item *
-
-If only the B<-prefix> argument is provided, or the B<-xprefix> and
-B<-exclude> options are combined:
-
- Would have backed up volumes which are prefixed with <string> [or <string>] . .
-
-=item *
-
-If only the B<-xprefix> argument is provided, or the B<-prefix> and
-B<-exclude> options are combined:
-
- Would have backed up volumes which are not prefixed with <string> [nor <string>] . .
-
-=item *
-
-If the B<-prefix> and B<-xprefix> arguments are combined:
-
- Would have backed up volumes which are prefixed with <string> [or <string>] \
- removing those which are prefixed with <x_string> [or <x_string>] . .
-
-=item *
-
-If the B<-prefix>, B<-xprefix>, and B<-exclude> options are provided:
-
- Would have backed up volumes which are not prefixed with <string> [nor <string>] \
- adding those which are prefixed with <x_string> [or <x_string>] . .
-
-=back
-
-=head1 EXAMPLES
-
-The following example creates a backup version of every read/write volume
-listed in the cell's VLDB whose name begins with the string B<user>.
-
- % vos backupsys -prefix user
-
-The following example, appropriate in the Example Corporation cell, creates a
-backup version of every read/write volume on the file server machine
-C<fs3.example.com>.
-
- % vos backupsys -server fs3.example.com
-
-The following example, appropriate in the Example Organization cell, creates a
-backup version of every read/write volume on the file server machine
-C<db1.example.org> except those whose name includes the string C<temp>.
-
- % vos backupsys -server db1.example.org -prefix '^.*temp'
-
-The following example creates a backup version of every volume listed in
-the cell's VLDB, excluding those whose names contain the string C<source>,
-but including those whose names contain the string C<source.current>.
-
- % vos backupsys -prefix '^.*source' -exclude -xprefix '^.*source\.current'
-
-=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<backup_addvolentry(8)>,
-L<vos(1)>,
-L<vos_backup(1)>
-
-UNIX manual page for regexp(5)
-
-=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.
--- /dev/null
+=head1 NAME
+
+vos_backupsys - Creates a backup volume for several read/write volumes
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos backupsys> S<<< [B<-prefix> <I<common prefix on volume(s)>>+] >>>
+ S<<< [B<-server> <I<machine name>>] >>>
+ S<<< [B<-partition> <I<partition name>>] >>>
+ [B<-exclude>] S<<< [B<-xprefix> <I<negative prefix on volume(s)>>+] >>>
+ [B<-dryrun>] 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 backups> S<<< [B<-pr> <I<common prefix on volume(s)>>+] >>>
+ S<<< [B<-s> <I<machine name>>] >>> S<<< [B<-pa> <I<partition name>>] >>>
+ [B<-ex>] S<<< [B<-x> <I<negative prefix on volume(s)>>+] >>> [B<-d>]
+ S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>] [B<-v>]
+ [B<-en>] [B<-nor>]
+ S<<< [B<-co> <I<config directory>>] >>>
+ [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos backupsys> command clones each indicated read/write volume to
+create a backup version, placing each clone at the same site as its
+read/write source version. It assigns each clone the same name as the
+read/write source, adding a C<.backup> extension. It assigns the volume ID
+number already allocated for the backup version in the Volume Location
+Database (VLDB). If a backup version already exists for a given volume,
+the new clone replaces it.
+
+To clone every read/write volume listed in the VLDB, omit all of the
+command's options. Otherwise, combine the command's options to clone
+various groups of volumes. The options use one of two basic criteria to
+select volumes: location (the B<-server> and B<-partition> arguments) or
+presence in the volume name of one of a set of specified character strings
+(the B<-prefix>, B<-exclude>, and B<-xprefix> options).
+
+To clone only volumes that reside on one file server machine, include the
+B<-server> argument. To clone only volumes that reside on one partition,
+combine the B<-server> and B<-partition> arguments. The B<-partition>
+argument can also be used alone to clone volumes that reside on the
+indicated partition on every file server machine. These arguments can be
+combined with those that select volumes based on their names.
+
+Combine the B<-prefix>, -exclude, and B<-xprefix> options (with or without
+the B<-server> and B<-partition> arguments) in the indicated ways to
+select volumes based on character strings contained in their names:
+
+=over 4
+
+=item *
+
+To clone every read/write volume at the specified location whose name
+includes one of a set of specified character strings (for example, begins
+with C<user.> or includes the string C<afs>), use the B<-prefix> argument
+or combine the B<-xprefix> and B<-exclude> options.
+
+=item *
+
+To clone every read/write volume at the specified location except those
+whose name includes one of a set of specified character strings, use the
+B<-xprefix> argument or combine the B<-prefix> and B<-exclude> options.
+
+=item *
+
+To clone every read/write volume at the specified location whose name
+includes one of one of a set of specified character strings, except those
+whose names include one of a different set of specified character strings,
+combine the B<-prefix> and B<-xprefix> arguments. The command creates a
+list of all volumes that match the B<-prefix> argument and then removes
+from the list the volumes that match the B<-xprefix> argument. For
+effective results, the strings specified by the B<-xprefix> argument must
+designate a subset of the volumes specified by the B<-prefix> argument.
+
+If the B<-exclude> flag is combined with the B<-prefix> and B<-xprefix>
+arguments, the command creates a list of all volumes that do not match the
+B<-prefix> argument and then adds to the list any volumes that match the
+B<-xprefix> argument. As when the B<-exclude> flag is not used, the result
+is effective only if the strings specified by the B<-xprefix> argument
+designate a subset of the volumes specified by the B<-prefix> argument.
+
+=back
+
+The B<-prefix> and B<-xprefix> arguments both accept multiple values,
+which can be used to define disjoint groups of volumes. Each value can be
+one of two types:
+
+=over 4
+
+=item *
+
+A simple character string, which matches volumes whose name begin with the
+string. All characters are interpreted literally (that is, characters that
+potentially have special meaning to the command shell, such as the period,
+have only their literal meaning).
+
+=item *
+
+A regular expression, which matches volumes whose names contain the
+expressions. Place a caret (C<^>) at the beginning of the expression, and
+enclose the entire string in single quotes (C<''>). Explaining regular
+expressions is outside the scope of this reference page; see the UNIX
+manual page for regexp(5) or (for a brief introduction)
+L<backup_addvolentry(8)>. As an example, the following expression matches
+volumes that have the string C<aix> anywhere in their names:
+
+ -prefix '^.*aix'
+
+=back
+
+To display a list of the volumes to be cloned, without actually cloning
+them, include the B<-dryrun> flag. To display a statement that summarizes
+the criteria being used to select volume, include the B<-verbose> flag.
+
+This command can be used to clone a single read/write volume; specify its
+complete name as the B<-prefix> argument. However, it is more efficient to
+use the B<vos backup> command, which employs a more streamlined technique
+for finding a single volume.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-prefix> <I<common prefix>>
+
+Specifies one or more simple character strings or regular expressions of
+any length; a volume whose name includes the string is placed on the set
+of volumes to be cloned. Include field separators (such as periods) if
+appropriate. This argument can be combined with any combination of the
+B<-server>, B<-partition>, B<-exclude>, and B<-xprefix> options.
+
+=item B<-server> <I<machine name>>
+
+Identifies the file server machine where each read/write source 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)>.
+
+This argument can be combined with any combination of the B<-prefix>,
+B<-partition>, B<-exclude>, and B<-xprefix> options.
+
+=item B<-partition> <I<partition name>>
+
+Identifies the partition where each read/write source volume
+resides. 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)>.
+
+This argument can be combined with any combination of the B<-prefix>,
+B<-server>, B<-exclude>, and B<-xprefix> options.
+
+=item B<-exclude>
+
+Reverses the meaning of the B<-prefix> or B<-xprefix> argument. This flag
+can be combined with any combination of the B<-prefix>, B<-server>,
+B<-partition>, and B<-xprefix> options.
+
+=item B<-xprefix> <I<negative prefix>>
+
+Specifies a simple character string or regular expression of any length; a
+volume whose name includes the string is removed from the set of volumes
+to be cloned. Include field separators (such as periods) if
+appropriate. This argument can be combined with any combination of the
+B<-prefix>, B<-server>, B<-partition>, and B<-exclude> options.
+
+=item B<-dryrun>
+
+Displays on the standard output stream a list of the volumes to be cloned,
+without actually cloning them.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 OUTPUT
+
+The command generates the following messages on the standard output stream
+to confirm that the operation was successful:
+
+ done
+ Total volumes backed up: <number_cloned>; failed to backup: <failures>
+
+If the B<-dryrun> flag is included, a list of the volumes to be backed up
+precedes the standard confirmation messages.
+
+If the B<-verbose> flag is included but not the B<-dryrun> flag, the
+following messages appear for each volume. The output concludes with the
+standard confirmation messages.
+
+ Creating backup volume for <volume_name> on <date/time>
+ {Recloning backup volume | Creating a new backup clone} <backup_volumeID> . . .done
+
+If both the B<-dryrun> and B<-verbose> flags are included, the output
+begins with a statement summarizing the criteria being used to select the
+volumes, followed by a list of the volumes and the standard confirmation
+messages. The format of the criteria summary statement depends on which
+other options are provided:
+
+=over 4
+
+=item *
+
+If only the B<-prefix> argument is provided, or the B<-xprefix> and
+B<-exclude> options are combined:
+
+ Would have backed up volumes which are prefixed with <string> [or <string>] . .
+
+=item *
+
+If only the B<-xprefix> argument is provided, or the B<-prefix> and
+B<-exclude> options are combined:
+
+ Would have backed up volumes which are not prefixed with <string> [nor <string>] . .
+
+=item *
+
+If the B<-prefix> and B<-xprefix> arguments are combined:
+
+ Would have backed up volumes which are prefixed with <string> [or <string>] \
+ removing those which are prefixed with <x_string> [or <x_string>] . .
+
+=item *
+
+If the B<-prefix>, B<-xprefix>, and B<-exclude> options are provided:
+
+ Would have backed up volumes which are not prefixed with <string> [nor <string>] \
+ adding those which are prefixed with <x_string> [or <x_string>] . .
+
+=back
+
+=head1 EXAMPLES
+
+The following example creates a backup version of every read/write volume
+listed in the cell's VLDB whose name begins with the string B<user>.
+
+ % vos backupsys -prefix user
+
+The following example, appropriate in the Example Corporation cell, creates a
+backup version of every read/write volume on the file server machine
+C<fs3.example.com>.
+
+ % vos backupsys -server fs3.example.com
+
+The following example, appropriate in the Example Organization cell, creates a
+backup version of every read/write volume on the file server machine
+C<db1.example.org> except those whose name includes the string C<temp>.
+
+ % vos backupsys -server db1.example.org -prefix '^.*temp'
+
+The following example creates a backup version of every volume listed in
+the cell's VLDB, excluding those whose names contain the string C<source>,
+but including those whose names contain the string C<source.current>.
+
+ % vos backupsys -prefix '^.*source' -exclude -xprefix '^.*source\.current'
+
+=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<backup_addvolentry(8)>,
+L<vos(1)>,
+L<vos_backup(1)>
+
+UNIX manual page for regexp(5)
+
+=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.
+++ /dev/null
-=head1 NAME
-
-vos_changeaddr - Changes or removes a file server machine's entry in the VLDB
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos changeaddr> S<<< B<-oldaddr> <I<original IP address>> >>>
- S<<< [B<-newaddr> <I<new IP address>>] >>> [B<-remove>]
- 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 changea> S<<< B<-o> <I<original IP address>> >>>
- S<<< [B<-ne> <I<new IP address>>] >>> [B<-r>]
- 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 changeaddr> command removes a server entry from the Volume
-Location Database (VLDB) when the B<-remove> flag is combined with the
-B<-oldaddr> argument. There must be no VLDB entries that list the machine
-as a site for any version of a volume (if necessary, use the B<vos move>
-or B<vos remove> command to more or remove volumes). It is appropriate to
-remove a VLDB server entry when removing the corresponding file server
-machine from service; this is the only recommended use of the command.
-
-To display all VLDB server entries, use the B<vos listaddrs> command.
-
-=head1 CAUTIONS
-
-Combining the command's B<-oldaddr> and B<-newaddr> arguments is no longer
-the appropriate way to change the IP address registered for a file server
-machine. Furthermore, if a machine is multihomed and its server entry
-includes several addresses, then the address specified with the
-B<-newaddr> argument replaces all of the addresses currently listed in the
-server entry that includes the address specified by the B<-oldaddr>
-argument. This effectively makes the machine single-homed with respect to
-AFS operations, which is probably not the desired result.
-
-The recommended method for changing the IP addresses in a server entry is
-instead to restart the C<fs> process group (which includes the File
-Server) after using the utilities provided by the operating system to
-reconfigure the machine's network interfaces. For a description of how the
-File Server constructs and registers a list of its network interfaces in
-the VLDB, see L<sysid(5)>.
-
-If, counter to recommended usage, the command is used to change the IP
-address in a server entry, it does not also change the names of machine
-entries in the Protection Database. Operations fail when they refer to a
-protection group that has an obsolete IP address in it. Use the B<pts
-rename> command to change the names of machine entries that correspond to
-the addresses changed with this command. Changing the address of a
-database server machine also requires updating the client and server
-versions of the F<CellServDB> file on every machine.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-oldaddr> <I<original IP address>>
-
-Specifies the IP address currently registered for the file server machine
-in the VLDB server entry. If there are multiple addresses registered for a
-multihomed machine, use any of them to identify the server entry.
-
-=item B<-newaddr> <I<new IP address>>
-
-Specifies the new IP address that replaces all currently registered
-addresses.
-
-=item B<-remove>
-
-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.
-
-=back
-
-=head1 EXAMPLES
-
-The following command removes the VLDB server entry that includes the IP
-address C<192.12.107.214>.
-
- % vos changeaddr -oldaddr 192.12.107.214 -remove
-
-=head1 PRIVILEGE REQUIRED
-
-Issuer must be listed in the F</usr/afs/etc/UserList> file on the machine
-specified with the B<-oldaddr> argument and on each database server
-machine.
-
-=head1 SEE ALSO
-
-L<CellServDB(5)>,
-L<UserList(5)>,
-L<sysid(5)>,
-L<fileserver(8)>,
-L<pts_rename(1)>,
-L<vos(1)>,
-L<vos_listaddrs(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.
--- /dev/null
+=head1 NAME
+
+vos_changeaddr - Changes or removes a file server machine's entry in the VLDB
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos changeaddr> S<<< B<-oldaddr> <I<original IP address>> >>>
+ S<<< [B<-newaddr> <I<new IP address>>] >>> [B<-remove>]
+ 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 changea> S<<< B<-o> <I<original IP address>> >>>
+ S<<< [B<-ne> <I<new IP address>>] >>> [B<-r>]
+ 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 changeaddr> command removes a server entry from the Volume
+Location Database (VLDB) when the B<-remove> flag is combined with the
+B<-oldaddr> argument. There must be no VLDB entries that list the machine
+as a site for any version of a volume (if necessary, use the B<vos move>
+or B<vos remove> command to more or remove volumes). It is appropriate to
+remove a VLDB server entry when removing the corresponding file server
+machine from service; this is the only recommended use of the command.
+
+To display all VLDB server entries, use the B<vos listaddrs> command.
+
+=head1 CAUTIONS
+
+Combining the command's B<-oldaddr> and B<-newaddr> arguments is no longer
+the appropriate way to change the IP address registered for a file server
+machine. Furthermore, if a machine is multihomed and its server entry
+includes several addresses, then the address specified with the
+B<-newaddr> argument replaces all of the addresses currently listed in the
+server entry that includes the address specified by the B<-oldaddr>
+argument. This effectively makes the machine single-homed with respect to
+AFS operations, which is probably not the desired result.
+
+The recommended method for changing the IP addresses in a server entry is
+instead to restart the C<fs> process group (which includes the File
+Server) after using the utilities provided by the operating system to
+reconfigure the machine's network interfaces. For a description of how the
+File Server constructs and registers a list of its network interfaces in
+the VLDB, see L<sysid(5)>.
+
+If, counter to recommended usage, the command is used to change the IP
+address in a server entry, it does not also change the names of machine
+entries in the Protection Database. Operations fail when they refer to a
+protection group that has an obsolete IP address in it. Use the B<pts
+rename> command to change the names of machine entries that correspond to
+the addresses changed with this command. Changing the address of a
+database server machine also requires updating the client and server
+versions of the F<CellServDB> file on every machine.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-oldaddr> <I<original IP address>>
+
+Specifies the IP address currently registered for the file server machine
+in the VLDB server entry. If there are multiple addresses registered for a
+multihomed machine, use any of them to identify the server entry.
+
+=item B<-newaddr> <I<new IP address>>
+
+Specifies the new IP address that replaces all currently registered
+addresses.
+
+=item B<-remove>
+
+Removes from the VLDB the server entry that includes the address specified
+by the B<-oldaddr> argument.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following command removes the VLDB server entry that includes the IP
+address C<192.12.107.214>.
+
+ % vos changeaddr -oldaddr 192.12.107.214 -remove
+
+=head1 PRIVILEGE REQUIRED
+
+Issuer must be listed in the F</usr/afs/etc/UserList> file on the machine
+specified with the B<-oldaddr> argument and on each database server
+machine.
+
+=head1 SEE ALSO
+
+L<CellServDB(5)>,
+L<UserList(5)>,
+L<sysid(5)>,
+L<fileserver(8)>,
+L<pts_rename(1)>,
+L<vos(1)>,
+L<vos_listaddrs(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.
+++ /dev/null
-=head1 NAME
-
-vos_changeloc - Change a volume's entry in the VLDB
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos changeloc> S<<< [B<-server>] <I<new server name>> >>>
- S<<< [B<-partition>] <I<new partition location>> >>>
- 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 changel> S<<< [B<-s>] <I<new server name>> >>>
- S<<< [B<-p>] <I<new partition location>> >>>
- 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 changeloc> command changes the location of a volume in the
-Volume Location Database (VLDB) without needing to contact the original
-file server on which the volume was hosted. This is useful when a file
-server has gone down permanently and the data that was stored on that
-server has been moved to a new file server with a different name and IP
-address (perhaps by mounting the same /vicepX partitions on a different
-host). After moving the data and running B<vos changeloc>, run B<vos
-syncvldb> and then B<vos syncserv> against the new server to ensure full
-synchronization of the VLDB with the file server.
-
-In essence, B<vos changeloc> performs the same operations on the VLDB as
-B<vos move>, but it does NOT move the data from one server's file system
-to another.
-
-=head1 CAUTIONS
-
-Using B<vos changeloc> changes the VLDB without modifying the file server
-data, so it inherently causes the VLDB to be out of sync with the data on
-the servers. It should only be used when recovering from server failure.
-If the servers are on-line, B<vos move> should be used instead. It is
-highly recommended that B<vos syncvldb> and B<vos syncserv> be run after
-using the B<vos changeloc> command to ensure properly synchronization of
-the VLDB with the file servers.
-
-=head1 OPTIONS
-
-B<vos changeloc> takes the following options:
-
-=over 4
-
-=item B<-server> <I<new server name>>
-
-Specifies the new server where the VLDB should believe 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>>
-
-Specifies the partition where the VLDB should believe the volume resides.
-Provide the B<-server> argument along with this one. 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 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.
-
-=back
-
-=head1 OUTPUT
-
-B<vos changeloc> shows a brief message upon completion:
-
- Changed location to server2 /vicepa for volume user.jdoe
-
-=head1 EXAMPLES
-
-The following command changes the location of the C<user.jdoe> volume to
-be F</vicepa> on the file server machine C<server2> while being verbose:
-
- % vos changeloc server2 a user.jdoe -verbose
- done
- Changed location to server2 /vicepa for volume user.jdoe
-
-The following command changes the location of the C<user.jdoe> volume to
-be F</vicepa> on C<server1> without being verbose:
-
- % vos changeloc server1 a user.jdoe
- Changed location to server1 /vicepa for volume user.jdoe
-
-=head1 PRIVILEGE REQUIRED
-
-The issuer must be listed in the F</usr/afs/etc/UserList> file 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_move(1)>,
-L<vos_syncserv(1)>,
-L<vos_syncvldb(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.
--- /dev/null
+=head1 NAME
+
+vos_changeloc - Change a volume's entry in the VLDB
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos changeloc> S<<< [B<-server>] <I<new server name>> >>>
+ S<<< [B<-partition>] <I<new partition location>> >>>
+ 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 changel> S<<< [B<-s>] <I<new server name>> >>>
+ S<<< [B<-p>] <I<new partition location>> >>>
+ 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 changeloc> command changes the location of a volume in the
+Volume Location Database (VLDB) without needing to contact the original
+file server on which the volume was hosted. This is useful when a file
+server has gone down permanently and the data that was stored on that
+server has been moved to a new file server with a different name and IP
+address (perhaps by mounting the same /vicepX partitions on a different
+host). After moving the data and running B<vos changeloc>, run B<vos
+syncvldb> and then B<vos syncserv> against the new server to ensure full
+synchronization of the VLDB with the file server.
+
+In essence, B<vos changeloc> performs the same operations on the VLDB as
+B<vos move>, but it does NOT move the data from one server's file system
+to another.
+
+=head1 CAUTIONS
+
+Using B<vos changeloc> changes the VLDB without modifying the file server
+data, so it inherently causes the VLDB to be out of sync with the data on
+the servers. It should only be used when recovering from server failure.
+If the servers are on-line, B<vos move> should be used instead. It is
+highly recommended that B<vos syncvldb> and B<vos syncserv> be run after
+using the B<vos changeloc> command to ensure properly synchronization of
+the VLDB with the file servers.
+
+=head1 OPTIONS
+
+B<vos changeloc> takes the following options:
+
+=over 4
+
+=item B<-server> <I<new server name>>
+
+Specifies the new server where the VLDB should believe 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>>
+
+Specifies the partition where the VLDB should believe the volume resides.
+Provide the B<-server> argument along with this one. 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 the name or volume ID number on which to operate.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 OUTPUT
+
+B<vos changeloc> shows a brief message upon completion:
+
+ Changed location to server2 /vicepa for volume user.jdoe
+
+=head1 EXAMPLES
+
+The following command changes the location of the C<user.jdoe> volume to
+be F</vicepa> on the file server machine C<server2> while being verbose:
+
+ % vos changeloc server2 a user.jdoe -verbose
+ done
+ Changed location to server2 /vicepa for volume user.jdoe
+
+The following command changes the location of the C<user.jdoe> volume to
+be F</vicepa> on C<server1> without being verbose:
+
+ % vos changeloc server1 a user.jdoe
+ Changed location to server1 /vicepa for volume user.jdoe
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must be listed in the F</usr/afs/etc/UserList> file 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_move(1)>,
+L<vos_syncserv(1)>,
+L<vos_syncvldb(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.
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
+++ /dev/null
-=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.
--- /dev/null
+=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.
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
+++ /dev/null
-=head1 NAME
-
-vos_delentry - Removes a volume entry from the VLDB.
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos delentry> S<<< [B<-id> <I<volume name or ID>>+] >>>
- S<<< [B<-prefix> <I<prefix of volume whose VLDB entry is to be deleted>>] >>>
- S<<< [B<-server> <I<machine name>>] >>>
- S<<< [B<-partition> <I<partition name>>] >>>
- S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
- [B<-dryrun>] [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
- S<<< [B<-config> <I<config directory>>] >>>
- [B<-help>]
-
-B<vos de> S<<< [B<-i> <I<volume name or ID>>+] >>>
- S<<< [B<-pr> <I<prefix of volume whose VLDB entry is to be deleted>>] >>>
- S<<< [B<-s> <I<machine name>>] >>> S<<< [B<-pa> <I<partition name>>] >>>
- S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>]
- [B<-d>] [B<-v>] [B<-e>] [B<-nor>]
- S<<< [B<-co> <I<config directory>>] >>>
- [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos delentry> command removes the Volume Location Database (VLDB)
-entry for each specified volume. A specified volume can be any of the
-three types (read/write, read-only, or backup), but the entire entry is
-removed no matter which type is provided. The command has no effect on the
-actual volumes on file server machines, if they exist.
-
-This command is useful if a volume removal operation did not update the
-VLDB (perhaps because the B<vos zap> command was used), but the system
-administrator does not feel it is necessary to use the B<vos syncserv> and
-B<vos syncvldb> commands to synchronize an entire file server machine.
-
-To remove the VLDB entry for a single volume, use the B<-id> argument. To
-remove groups of volumes, combine the B<-prefix>, B<-server>, and
-B<-partition> arguments. The following list describes how to remove the
-VLDB entry for the indicated group of volumes:
-
-=over 4
-
-=item *
-
-For every volume whose name begins with a certain character string (for
-example, C<sys.> or C<user.>): use the B<-prefix> argument.
-
-=item *
-
-Every volume for which the VLDB lists a site on a certain file server
-machine: specify the file server name with the B<-server> argument.
-
-=item *
-
-Every volume for which the VLDB lists a site on a partition of the same
-name (for instance, on the F</vicepa> partition on any file server
-machine): specify the partition name with the B<-partition> argument.
-
-=item *
-
-Every volume for which the VLDB lists a site one a specific partition of a
-file server machine: specify both the B<-server> and B<-partition>
-arguments.
-
-=item *
-
-Every volume whose name begins with a certain prefix and for which the
-VLDB lists a site on a file server machine: combine the B<-prefix> and
-B<-server> arguments. Combine the B<-prefix> argument with the
-B<-partition> argument, or both the B<-server> and B<-partition>
-arguments, to remove a more specific group of volumes.
-
-=back
-
-=head1 CAUTIONS
-
-Do not use this command to remove a volume in normal circumstances; it
-does not remove a volume from the file server machine, and so is likely to
-make the VLDB inconsistent with state of the volumes on server
-machines. Use the B<vos remove> command to remove both the volume and its
-VLDB entry.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-id> <I<volume name or ID>>+
-
-Specifies the complete name or the volume ID number of each volume for
-which to remove the VLDB entry. The entire entry is removed, regardless of
-whether the read/write, read-only, or backup version is indicated.
-Provide this argument or some combination of the B<-prefix>, B<-server>,
-and B<-partition> arguments.
-
-=item B<-prefix> <I<prefix of volume entry>
-
-Specifies a character string of any length; the VLDB entry for a volume
-whose name begins with the string is removed. Include field separators
-(such as periods) if appropriate. Combine this argument with the
-B<-server> argument, B<-partition> argument, or both.
-
-=item B<-server> <I<server name>>
-
-Identifies a file server machine; if a volume's VLDB entry lists a site on
-the machine, the entry is removed. Provide the machine's IP address or its
-host name (either fully qualified or using an unambiguous
-abbreviation). For details, see L<vos(1)>.
-
-Combine this argument with the B<-prefix> argument, the B<-partition>
-argument, or both.
-
-=item B<-partition> <I<partition name>>
-
-Identifies a partition; if a volume's VLDB entry lists a site on the
-partition, the entry is removed. Provide the partition's complete name
-with preceding slash (for example, F</vicepa>) or use one of the three
-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.
-
-=back
-
-=head1 OUTPUT
-
-The following message confirms the success of the command by indicating
-how many VLDB entries were removed.
-
- Deleted <number> VLDB entries
-
-=head1 EXAMPLES
-
-The following command removes the VLDB entry for the volume C<user.temp>.
-
- % vos delentry user.temp
-
-The following command removes the VLDB entry for every volume whose name
-begins with the string C<test> and for which the VLDB lists a site on the
-file server machine C<fs3.example.com>.
-
- % vos delentry -prefix test -server fs3.example.com
-
-=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_remove(1)>,
-L<vos_syncserv(1)>,
-L<vos_syncvldb(1)>,
-L<vos_zap(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.
--- /dev/null
+=head1 NAME
+
+vos_delentry - Removes a volume entry from the VLDB.
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos delentry> S<<< [B<-id> <I<volume name or ID>>+] >>>
+ S<<< [B<-prefix> <I<prefix of volume whose VLDB entry is to be deleted>>] >>>
+ S<<< [B<-server> <I<machine name>>] >>>
+ S<<< [B<-partition> <I<partition name>>] >>>
+ S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
+ [B<-dryrun>] [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
+ S<<< [B<-config> <I<config directory>>] >>>
+ [B<-help>]
+
+B<vos de> S<<< [B<-i> <I<volume name or ID>>+] >>>
+ S<<< [B<-pr> <I<prefix of volume whose VLDB entry is to be deleted>>] >>>
+ S<<< [B<-s> <I<machine name>>] >>> S<<< [B<-pa> <I<partition name>>] >>>
+ S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>]
+ [B<-d>] [B<-v>] [B<-e>] [B<-nor>]
+ S<<< [B<-co> <I<config directory>>] >>>
+ [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos delentry> command removes the Volume Location Database (VLDB)
+entry for each specified volume. A specified volume can be any of the
+three types (read/write, read-only, or backup), but the entire entry is
+removed no matter which type is provided. The command has no effect on the
+actual volumes on file server machines, if they exist.
+
+This command is useful if a volume removal operation did not update the
+VLDB (perhaps because the B<vos zap> command was used), but the system
+administrator does not feel it is necessary to use the B<vos syncserv> and
+B<vos syncvldb> commands to synchronize an entire file server machine.
+
+To remove the VLDB entry for a single volume, use the B<-id> argument. To
+remove groups of volumes, combine the B<-prefix>, B<-server>, and
+B<-partition> arguments. The following list describes how to remove the
+VLDB entry for the indicated group of volumes:
+
+=over 4
+
+=item *
+
+For every volume whose name begins with a certain character string (for
+example, C<sys.> or C<user.>): use the B<-prefix> argument.
+
+=item *
+
+Every volume for which the VLDB lists a site on a certain file server
+machine: specify the file server name with the B<-server> argument.
+
+=item *
+
+Every volume for which the VLDB lists a site on a partition of the same
+name (for instance, on the F</vicepa> partition on any file server
+machine): specify the partition name with the B<-partition> argument.
+
+=item *
+
+Every volume for which the VLDB lists a site one a specific partition of a
+file server machine: specify both the B<-server> and B<-partition>
+arguments.
+
+=item *
+
+Every volume whose name begins with a certain prefix and for which the
+VLDB lists a site on a file server machine: combine the B<-prefix> and
+B<-server> arguments. Combine the B<-prefix> argument with the
+B<-partition> argument, or both the B<-server> and B<-partition>
+arguments, to remove a more specific group of volumes.
+
+=back
+
+=head1 CAUTIONS
+
+Do not use this command to remove a volume in normal circumstances; it
+does not remove a volume from the file server machine, and so is likely to
+make the VLDB inconsistent with state of the volumes on server
+machines. Use the B<vos remove> command to remove both the volume and its
+VLDB entry.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-id> <I<volume name or ID>>+
+
+Specifies the complete name or the volume ID number of each volume for
+which to remove the VLDB entry. The entire entry is removed, regardless of
+whether the read/write, read-only, or backup version is indicated.
+Provide this argument or some combination of the B<-prefix>, B<-server>,
+and B<-partition> arguments.
+
+=item B<-prefix> <I<prefix of volume entry>
+
+Specifies a character string of any length; the VLDB entry for a volume
+whose name begins with the string is removed. Include field separators
+(such as periods) if appropriate. Combine this argument with the
+B<-server> argument, B<-partition> argument, or both.
+
+=item B<-server> <I<server name>>
+
+Identifies a file server machine; if a volume's VLDB entry lists a site on
+the machine, the entry is removed. Provide the machine's IP address or its
+host name (either fully qualified or using an unambiguous
+abbreviation). For details, see L<vos(1)>.
+
+Combine this argument with the B<-prefix> argument, the B<-partition>
+argument, or both.
+
+=item B<-partition> <I<partition name>>
+
+Identifies a partition; if a volume's VLDB entry lists a site on the
+partition, the entry is removed. Provide the partition's complete name
+with preceding slash (for example, F</vicepa>) or use one of the three
+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<-dryrun>
+
+Show the actions which would be taken, but do not make changes.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 OUTPUT
+
+The following message confirms the success of the command by indicating
+how many VLDB entries were removed.
+
+ Deleted <number> VLDB entries
+
+=head1 EXAMPLES
+
+The following command removes the VLDB entry for the volume C<user.temp>.
+
+ % vos delentry user.temp
+
+The following command removes the VLDB entry for every volume whose name
+begins with the string C<test> and for which the VLDB lists a site on the
+file server machine C<fs3.example.com>.
+
+ % vos delentry -prefix test -server fs3.example.com
+
+=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_remove(1)>,
+L<vos_syncserv(1)>,
+L<vos_syncvldb(1)>,
+L<vos_zap(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.
+++ /dev/null
-=head1 NAME
-
-vos_endtrans - Ends a volserver transaction
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos endtrans> S<<< B<-server> <I<machine name>> >>>
- S<<< B<-transaction> <I<transaction 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 st> S<<< B<-s> <I<machine name>> >>>
- S<<< B<-t> <I<transaction 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 endtrans> command ends a specific transaction on the Volume
-Server for a specific volume. Under normal operation this command should
-never need to be used, but it can be useful to reduce the amount of time
-a volume is offline after an accidental command, or a L<B<vos>|vos(1)>
-process crash.
-
-Many L<B<vos>|vos(1)> commands, when they interact with a volume, create
-what is called a transaction in order to perform many different
-operations on a volume. If the L<B<vos>|vos(1)> process exits uncleanly,
-transactions may still stay open for the manipulated volumes, and the
-Volume Server may deny any further operations on those volumes while the
-transactions are still open. B<vos endtrans> allows you to end these
-transactions and make the volumes usable again without needing to
-restart the volserver.
-
-To find out what transactions are running on a Volume Server and what
-their transaction IDs are, see the L<B<vos status>|vos_status(1)>
-command.
-
-=head1 CAUTIONS
-
-This command is not used during normal OpenAFS administration. If used
-improperly, this can negatively impact currently-running
-L<B<vos>|vos(1)> operations. Only run this on a transaction if you are
-certain that the program that created the transaction is no longer
-running.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-server> <I<server name>>
-
-Identifies the file server machine running the Volume Server on which to
-end the transaction. 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<-transaction> <I<transaction ID>>
-
-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.
-
-=back
-
-=head1 EXAMPLES
-
-The following example illustrates the kind of output that can appear
-when a volume operation was about to be attempted on the Volume Server
-on C<fs1.example.com>, but the process performing the operation never
-actually did anything with the volume:
-
- % vos status fs1.example.com
- --------------------------------------------
- transaction: 575 created: Fri Oct 16 16:55:54 2009
- attachFlags: offline
- volume: 536871080 partition: /vicepb procedure: TransCreate
- --------------------------------------------
- % vos endtrans fs1.example.com 575
- % vos status fs1.example.com
- No active transactions on fs1.example.com
-
-=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. 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_status(1)>
-
-=head1 COPYRIGHT
-
-Copyright 2009 Sine Nomine Associates
-
-This documentation is covered by the BSD License as written in the
-doc/LICENSE file. This man page was written by Andrew Deason for
-OpenAFS.
--- /dev/null
+=head1 NAME
+
+vos_endtrans - Ends a volserver transaction
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos endtrans> S<<< B<-server> <I<machine name>> >>>
+ S<<< B<-transaction> <I<transaction 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 st> S<<< B<-s> <I<machine name>> >>>
+ S<<< B<-t> <I<transaction 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 endtrans> command ends a specific transaction on the Volume
+Server for a specific volume. Under normal operation this command should
+never need to be used, but it can be useful to reduce the amount of time
+a volume is offline after an accidental command, or a L<B<vos>|vos(1)>
+process crash.
+
+Many L<B<vos>|vos(1)> commands, when they interact with a volume, create
+what is called a transaction in order to perform many different
+operations on a volume. If the L<B<vos>|vos(1)> process exits uncleanly,
+transactions may still stay open for the manipulated volumes, and the
+Volume Server may deny any further operations on those volumes while the
+transactions are still open. B<vos endtrans> allows you to end these
+transactions and make the volumes usable again without needing to
+restart the volserver.
+
+To find out what transactions are running on a Volume Server and what
+their transaction IDs are, see the L<B<vos status>|vos_status(1)>
+command.
+
+=head1 CAUTIONS
+
+This command is not used during normal OpenAFS administration. If used
+improperly, this can negatively impact currently-running
+L<B<vos>|vos(1)> operations. Only run this on a transaction if you are
+certain that the program that created the transaction is no longer
+running.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-server> <I<server name>>
+
+Identifies the file server machine running the Volume Server on which to
+end the transaction. 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<-transaction> <I<transaction ID>>
+
+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)>.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following example illustrates the kind of output that can appear
+when a volume operation was about to be attempted on the Volume Server
+on C<fs1.example.com>, but the process performing the operation never
+actually did anything with the volume:
+
+ % vos status fs1.example.com
+ --------------------------------------------
+ transaction: 575 created: Fri Oct 16 16:55:54 2009
+ attachFlags: offline
+ volume: 536871080 partition: /vicepb procedure: TransCreate
+ --------------------------------------------
+ % vos endtrans fs1.example.com 575
+ % vos status fs1.example.com
+ No active transactions on fs1.example.com
+
+=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. 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_status(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2009 Sine Nomine Associates
+
+This documentation is covered by the BSD License as written in the
+doc/LICENSE file. This man page was written by Andrew Deason for
+OpenAFS.
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
+++ /dev/null
-=head1 NAME
-
-vos_listaddrs - Displays all VLDB server entries
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos listaddrs> S<<< [B<-uuid> <I<uuid of server>>] >>>
- S<<< [B<-host> <I<address of host>>] >>> [B<-printuuid>]
- 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 lista> [B<-u> <I<uuid of server>>] >>>
- S<<< [B<-h> <I<address of host>>] >>> [B<-p>]
- S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>]
- [B<-v>] [B<-e>] [B<-nor>]
- S<<< [B<-co> <I<config directory>>] >>>
- [B<-he>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos listaddrs> command displays all of the server entries from the
-Volume Location Database (VLDB). An entry is created as the File Server
-initializes and registers the contents of its F</usr/afs/local/sysid> file
-in the VLDB.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-host> <I<address of host>>
-
-Rather than displaying all the server entries, display only server entries
-for the specified host. This will show all multihomed addresses registered
-by that File Server in the VLDB.
-
-=item B<-uuid> <I<uuid of server>>
-
-Rather than displaying all the server entries, display only server entries
-for the File Server with the specified UUID. This will show all multihomed
-addresses registered by that File Server in the VLDB and also allows
-mapping a File Server UUID to its address.
-
-=item B<-printuuid>
-
-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.
-
-=back
-
-=head1 OUTPUT
-
-The output displays all server entries from the VLDB, each on its own
-line. If a file server machine is multihomed, all of its registered
-addresses appear on the line. The first one is the one reported as a
-volume's site in the output from the B<vos examine> and B<vos listvldb>
-commands.
-
-The VLDB records IP addresses, and the command interpreter has the local
-name service (either a process like the Domain Name Service or a local
-host table) translate them to hostnames before displaying them. If an IP
-address appears in the output, it is not possible to translate it.
-
-The existence of an entry does not necessarily indicate that the machine
-that is still an active file server machine. To remove obsolete server
-entries, use the B<vos changeaddr> command with the B<-remove> argument.
-
-=head1 EXAMPLES
-
-The following command displays the VLDB server entries in the Example
-Corporation cell:
-
- % vos listaddrs
- sv5.example.com
- sv1.example.com
- sv2.example.com afs2.example.com
- sv6.example.com
-
-The following command displays the VLDB server entry and UUID for
-host sv5.example.com in the Example Corporation cell:
-
- % vos listaddrs -p -ho sv5.example.com
- UUID: 000c5aff-8246-1699-96-c4-437b5a45aa77
- sv5.example.com
-
-=head1 PRIVILEGE REQUIRED
-
-None
-
-=head1 SEE ALSO
-
-L<fs_uuid(1)>,
-L<sysid(5)>,
-L<vos(1)>,
-L<vos_changeaddr(1)>,
-L<vos_examine(1)>,
-L<vos_listvldb(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.
--- /dev/null
+=head1 NAME
+
+vos_listaddrs - Displays all VLDB server entries
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos listaddrs> S<<< [B<-uuid> <I<uuid of server>>] >>>
+ S<<< [B<-host> <I<address of host>>] >>> [B<-printuuid>]
+ 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 lista> [B<-u> <I<uuid of server>>] >>>
+ S<<< [B<-h> <I<address of host>>] >>> [B<-p>]
+ S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>]
+ [B<-v>] [B<-e>] [B<-nor>]
+ S<<< [B<-co> <I<config directory>>] >>>
+ [B<-he>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos listaddrs> command displays all of the server entries from the
+Volume Location Database (VLDB). An entry is created as the File Server
+initializes and registers the contents of its F</usr/afs/local/sysid> file
+in the VLDB.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-host> <I<address of host>>
+
+Rather than displaying all the server entries, display only server entries
+for the specified host. This will show all multihomed addresses registered
+by that File Server in the VLDB.
+
+=item B<-uuid> <I<uuid of server>>
+
+Rather than displaying all the server entries, display only server entries
+for the File Server with the specified UUID. This will show all multihomed
+addresses registered by that File Server in the VLDB and also allows
+mapping a File Server UUID to its address.
+
+=item B<-printuuid>
+
+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.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 OUTPUT
+
+The output displays all server entries from the VLDB, each on its own
+line. If a file server machine is multihomed, all of its registered
+addresses appear on the line. The first one is the one reported as a
+volume's site in the output from the B<vos examine> and B<vos listvldb>
+commands.
+
+The VLDB records IP addresses, and the command interpreter has the local
+name service (either a process like the Domain Name Service or a local
+host table) translate them to hostnames before displaying them. If an IP
+address appears in the output, it is not possible to translate it.
+
+The existence of an entry does not necessarily indicate that the machine
+that is still an active file server machine. To remove obsolete server
+entries, use the B<vos changeaddr> command with the B<-remove> argument.
+
+=head1 EXAMPLES
+
+The following command displays the VLDB server entries in the Example
+Corporation cell:
+
+ % vos listaddrs
+ sv5.example.com
+ sv1.example.com
+ sv2.example.com afs2.example.com
+ sv6.example.com
+
+The following command displays the VLDB server entry and UUID for
+host sv5.example.com in the Example Corporation cell:
+
+ % vos listaddrs -p -ho sv5.example.com
+ UUID: 000c5aff-8246-1699-96-c4-437b5a45aa77
+ sv5.example.com
+
+=head1 PRIVILEGE REQUIRED
+
+None
+
+=head1 SEE ALSO
+
+L<fs_uuid(1)>,
+L<sysid(5)>,
+L<vos(1)>,
+L<vos_changeaddr(1)>,
+L<vos_examine(1)>,
+L<vos_listvldb(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.
+++ /dev/null
-=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.
--- /dev/null
+=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.
+++ /dev/null
-=head1 NAME
-
-vos_listvldb - Displays a volume's VLDB entry
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos listvldb> S<<< [B<-name> <I<volume name or ID>>] >>>
- S<<< [B<-server> <I<machine name>>] >>>
- S<<< [B<-partition> <I<partition name>>] >>>
- [B<-locked>] [B<-quiet>] [B<-nosort>]
- 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 listvl> S<<< [B<-na> <I<volume name or ID>>] >>>
- S<<< [B<-s> <I<machine name>>] >>>
- S<<< [B<-p> <I<partition name>>] >>>
- [B<-lock>] [B<-q>] [B<-nos>] S<<< [B<-c> <I<cell name>>] >>>
- [B<-noa>] [B<-loca>] [B<-v>] [B<-e>] [B<-nor>]
- S<<< [B<-co> <I<config directory>>] >>>
- [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos listvldb> command formats and displays information from the
-Volume Location Database (VLDB) entry for each volume specified. The
-output depends on the combination of options supplied on the command
-line. Combine options as indicated to display the desired type of VLDB
-entries:
-
-=over 4
-
-=item *
-
-Every entry in the VLDB: provide no options.
-
-=item *
-
-Every VLDB entry that mentions a certain file server machine as the site
-for a volume: specify the machine's name as the B<-server> argument.
-
-=item *
-
-Every VLDB entry that mentions a certain partition on any file server
-machine as the site for a volume: specify the partition name as the
-B<-partition> argument.
-
-=item *
-
-Every VLDB entry that mentions a certain partition on a certain file
-server machine as the site for a volume: combine the B<-server> and
-B<-partition> arguments.
-
-=item *
-
-A single VLDB entry: specify a volume name or ID number with the B<-name>
-argument.
-
-=item *
-
-The VLDB entry only for the volumes with locked VLDB entries found at a
-certain site: combine the B<-locked> flag with any of arguments that
-define sites.
-
-=back
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-name> <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<-server> <I<server name>>
-
-Identifies the file server machine listed as a site in each VLDB entry to
-display. Provide the machine's IP address or its host name (either fully
-qualified or using an unambiguous abbreviation). For details, see
-L<vos(1)>.
-
-This argument can be combined with the B<-partition> argument, the
-B<-locked> flag, or both.
-
-=item B<-partition> <I<partition name>>
-
-Identifies the partition (on the file server machine specified by the
-B<-server> argument) listed as a site in each VLDB entry to
-display. 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)>.
-
-This argument can be combined with the B<-server> argument, the B<-locked>
-flag, or both.
-
-=item B<-locked>
-
-Displays only locked VLDB entries. This flag can be combined with the
-B<-server> argument, the B<-partition> argument, or both.
-
-=item B<-quiet>
-
-Suppresses the lines that summarize the number of volumes listed and their
-status, which otherwise appear at the beginning and end of the output when
-the output includes more than one volume.
-
-=item B<-nosort>
-
-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.
-
-=back
-
-=head1 OUTPUT
-
-If the output includes more than one VLDB entry, by default the first line
-reports which file server machine, partition, or both, houses the
-volumes. The final line of output reports the total number of entries
-displayed. Including the B<-quiet> flag suppresses these lines.
-
-By default, volumes are sorted alphabetically by volume name. Including
-the B<-nosort> flag skips the sorting step, which can speed up the
-production of output if there are a large number of entries.
-
-The VLDB entry for each volume includes the following information:
-
-=over 4
-
-=item *
-
-The base (read/write) volume name. The read-only and backup versions have
-the same name with a C<.readonly> and C<.backup> extension, respectively.
-
-=item *
-
-The volume ID numbers allocated to the versions of the volume that
-actually exist, in fields labeled C<RWrite> for the read/write, C<ROnly>
-for the read-only, C<Backup> for the backup, and C<RClone> for the
-ReleaseClone. (If a field does not appear, the corresponding version of
-the volume does not exist.) The appearance of the C<RClone> field normally
-indicates that a release operation did not complete successfully; the
-C<Old release> and C<New release> flags often also appear on one or more
-of the site definition lines described just following.
-
-=item *
-
-The number of sites that house a read/write or read-only copy of the
-volume, following the string C<< number of sites -> >>.
-
-=item *
-
-A line for each site that houses a read/write or read-only copy of the
-volume, specifying the file server machine, partition, and type of volume
-(C<RW> for read/write or C<RO> for read-only). If a backup version exists,
-it is understood to share the read/write site. Several flags can appear
-with a site definition:
-
-=over 4
-
-=item Not released
-
-Indicates that the vos release command has not been issued since the B<vos
-addsite> command was used to define the read-only site.
-
-=item Old release
-
-Indicates that a vos release command did not complete successfully,
-leaving the previous, obsolete version of the volume at this site.
-
-=item New release
-
-Indicates that a vos release command did not complete successfully, but
-that this site did receive the correct new version of the volume.
-
-=back
-
-=item *
-
-If the VLDB entry is locked, the string C<Volume is currently LOCKED>, as
-well as (in OpenAFS 1.5.75 and later) one or more of the following strings:
-
-=over 4
-
-=item Volume is locked for a move operation
-
-Indicates that the volume was locked due to a B<vos move> or a B<vos
-convertROtoRW> command.
-
-=item Volume is locked for a release operation
-
-Indicates that the volume was locked due to a B<vos release> command.
-
-=item Volume is locked for a backup operation
-
-Indicates that the volume was locked due to a B<vos backup> command.
-
-=item Volume is locked for a delete/misc operation
-
-Indicates that the volume was locked due to a B<vos delentry>, B<vos
-addsite>, B<vos remsite>, B<vos changeloc>, B<vos syncvldb>, B<vos
-syncserv>, B<vos rename>, or B<vos lock> command.
-
-=item Volume is locked for a dump/restore operation
-
-Indicates that the volume was locked due to a B<vos dump> or B<vos restore>
-command.
-
-=back
-
-=back
-
-For further discussion of the C<New release> and C<Old release> flags, see
-L<vos_release(1)>.
-
-=head1 EXAMPLES
-
-The following command displays VLDB information for the Example Corporation
-volume called C<usr>, which has two read-only replication sites:
-
- % vos listvldb -name usr
- usr
- RWrite: 5360870981 ROnly: 536870982 Backup: 536870983
- number of sites -> 3
- server fs1.example.com partition /vicepa RO Site
- server fs3.example.com partition /vicepa RO Site
- server fs2.example.com partition /vicepb RW Site
-
-The following example shows entries for two of the volumes that reside on
-the file server machine C<fs4.example.com>. The first VLDB entry is currently
-locked. There are 508 entries that mention the machine as a volume site.
-
- % vos listvldb -server fs4.example.com
- VLDB entries for server fs4.example.com
- . . . .
- . . . .
- user.smith
- RWrite: 278541326 ROnly: 278541327 Backup: 278542328
- number of sites -> 1
- server fs4.example.com partition /vicepg RW Site
- Volume is currently LOCKED
- user.terry
- RWrite 354287190 ROnly 354287191 Backup 354287192
- number of sites -> 1
- server fs4.example.com partition /vicepc RW Site
- . . . .
- . . . .
- Total entries: 508
-
-=head1 PRIVILEGE REQUIRED
-
-None
-
-=head1 SEE ALSO
-
-L<vos(1)>,
-L<vos_examine(1)>,
-L<vos_listvol(1)>,
-L<vos_lock(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.
--- /dev/null
+=head1 NAME
+
+vos_listvldb - Displays a volume's VLDB entry
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos listvldb> S<<< [B<-name> <I<volume name or ID>>] >>>
+ S<<< [B<-server> <I<machine name>>] >>>
+ S<<< [B<-partition> <I<partition name>>] >>>
+ [B<-locked>] [B<-quiet>] [B<-nosort>]
+ 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 listvl> S<<< [B<-na> <I<volume name or ID>>] >>>
+ S<<< [B<-s> <I<machine name>>] >>>
+ S<<< [B<-p> <I<partition name>>] >>>
+ [B<-lock>] [B<-q>] [B<-nos>] S<<< [B<-c> <I<cell name>>] >>>
+ [B<-noa>] [B<-loca>] [B<-v>] [B<-e>] [B<-nor>]
+ S<<< [B<-co> <I<config directory>>] >>>
+ [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos listvldb> command formats and displays information from the
+Volume Location Database (VLDB) entry for each volume specified. The
+output depends on the combination of options supplied on the command
+line. Combine options as indicated to display the desired type of VLDB
+entries:
+
+=over 4
+
+=item *
+
+Every entry in the VLDB: provide no options.
+
+=item *
+
+Every VLDB entry that mentions a certain file server machine as the site
+for a volume: specify the machine's name as the B<-server> argument.
+
+=item *
+
+Every VLDB entry that mentions a certain partition on any file server
+machine as the site for a volume: specify the partition name as the
+B<-partition> argument.
+
+=item *
+
+Every VLDB entry that mentions a certain partition on a certain file
+server machine as the site for a volume: combine the B<-server> and
+B<-partition> arguments.
+
+=item *
+
+A single VLDB entry: specify a volume name or ID number with the B<-name>
+argument.
+
+=item *
+
+The VLDB entry only for the volumes with locked VLDB entries found at a
+certain site: combine the B<-locked> flag with any of arguments that
+define sites.
+
+=back
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-name> <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<-server> <I<server name>>
+
+Identifies the file server machine listed as a site in each VLDB entry to
+display. Provide the machine's IP address or its host name (either fully
+qualified or using an unambiguous abbreviation). For details, see
+L<vos(1)>.
+
+This argument can be combined with the B<-partition> argument, the
+B<-locked> flag, or both.
+
+=item B<-partition> <I<partition name>>
+
+Identifies the partition (on the file server machine specified by the
+B<-server> argument) listed as a site in each VLDB entry to
+display. 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)>.
+
+This argument can be combined with the B<-server> argument, the B<-locked>
+flag, or both.
+
+=item B<-locked>
+
+Displays only locked VLDB entries. This flag can be combined with the
+B<-server> argument, the B<-partition> argument, or both.
+
+=item B<-quiet>
+
+Suppresses the lines that summarize the number of volumes listed and their
+status, which otherwise appear at the beginning and end of the output when
+the output includes more than one volume.
+
+=item B<-nosort>
+
+Suppresses the default sorting of volume entries alphabetically by volume
+name.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 OUTPUT
+
+If the output includes more than one VLDB entry, by default the first line
+reports which file server machine, partition, or both, houses the
+volumes. The final line of output reports the total number of entries
+displayed. Including the B<-quiet> flag suppresses these lines.
+
+By default, volumes are sorted alphabetically by volume name. Including
+the B<-nosort> flag skips the sorting step, which can speed up the
+production of output if there are a large number of entries.
+
+The VLDB entry for each volume includes the following information:
+
+=over 4
+
+=item *
+
+The base (read/write) volume name. The read-only and backup versions have
+the same name with a C<.readonly> and C<.backup> extension, respectively.
+
+=item *
+
+The volume ID numbers allocated to the versions of the volume that
+actually exist, in fields labeled C<RWrite> for the read/write, C<ROnly>
+for the read-only, C<Backup> for the backup, and C<RClone> for the
+ReleaseClone. (If a field does not appear, the corresponding version of
+the volume does not exist.) The appearance of the C<RClone> field normally
+indicates that a release operation did not complete successfully; the
+C<Old release> and C<New release> flags often also appear on one or more
+of the site definition lines described just following.
+
+=item *
+
+The number of sites that house a read/write or read-only copy of the
+volume, following the string C<< number of sites -> >>.
+
+=item *
+
+A line for each site that houses a read/write or read-only copy of the
+volume, specifying the file server machine, partition, and type of volume
+(C<RW> for read/write or C<RO> for read-only). If a backup version exists,
+it is understood to share the read/write site. Several flags can appear
+with a site definition:
+
+=over 4
+
+=item Not released
+
+Indicates that the vos release command has not been issued since the B<vos
+addsite> command was used to define the read-only site.
+
+=item Old release
+
+Indicates that a vos release command did not complete successfully,
+leaving the previous, obsolete version of the volume at this site.
+
+=item New release
+
+Indicates that a vos release command did not complete successfully, but
+that this site did receive the correct new version of the volume.
+
+=back
+
+=item *
+
+If the VLDB entry is locked, the string C<Volume is currently LOCKED>, as
+well as (in OpenAFS 1.5.75 and later) one or more of the following strings:
+
+=over 4
+
+=item Volume is locked for a move operation
+
+Indicates that the volume was locked due to a B<vos move> or a B<vos
+convertROtoRW> command.
+
+=item Volume is locked for a release operation
+
+Indicates that the volume was locked due to a B<vos release> command.
+
+=item Volume is locked for a backup operation
+
+Indicates that the volume was locked due to a B<vos backup> command.
+
+=item Volume is locked for a delete/misc operation
+
+Indicates that the volume was locked due to a B<vos delentry>, B<vos
+addsite>, B<vos remsite>, B<vos changeloc>, B<vos syncvldb>, B<vos
+syncserv>, B<vos rename>, or B<vos lock> command.
+
+=item Volume is locked for a dump/restore operation
+
+Indicates that the volume was locked due to a B<vos dump> or B<vos restore>
+command.
+
+=back
+
+=back
+
+For further discussion of the C<New release> and C<Old release> flags, see
+L<vos_release(1)>.
+
+=head1 EXAMPLES
+
+The following command displays VLDB information for the Example Corporation
+volume called C<usr>, which has two read-only replication sites:
+
+ % vos listvldb -name usr
+ usr
+ RWrite: 5360870981 ROnly: 536870982 Backup: 536870983
+ number of sites -> 3
+ server fs1.example.com partition /vicepa RO Site
+ server fs3.example.com partition /vicepa RO Site
+ server fs2.example.com partition /vicepb RW Site
+
+The following example shows entries for two of the volumes that reside on
+the file server machine C<fs4.example.com>. The first VLDB entry is currently
+locked. There are 508 entries that mention the machine as a volume site.
+
+ % vos listvldb -server fs4.example.com
+ VLDB entries for server fs4.example.com
+ . . . .
+ . . . .
+ user.smith
+ RWrite: 278541326 ROnly: 278541327 Backup: 278542328
+ number of sites -> 1
+ server fs4.example.com partition /vicepg RW Site
+ Volume is currently LOCKED
+ user.terry
+ RWrite 354287190 ROnly 354287191 Backup 354287192
+ number of sites -> 1
+ server fs4.example.com partition /vicepc RW Site
+ . . . .
+ . . . .
+ Total entries: 508
+
+=head1 PRIVILEGE REQUIRED
+
+None
+
+=head1 SEE ALSO
+
+L<vos(1)>,
+L<vos_examine(1)>,
+L<vos_listvol(1)>,
+L<vos_lock(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.
+++ /dev/null
-=head1 NAME
-
-vos_listvol - Displays information from a volume header
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos listvol> S<<< B<-server> <I<machine name>> >>>
- S<<< [B<-partition> <I<partition name>>] >>>
- [B<-fast>] [B<-long>] [B<-quiet>]
- [B<-extended>] [B<-format>]
- 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 listvo> S<<< B<-s> <I<machine name>> >>>
- S<<< [B<-p> <I<partition name>>] >>>
- [B<-fa>] [-lon] [B<-q>] [B<-ex>] [B<-fo>]
- S<<< [B<-c> <I<cell name>>] >>>
- [B<-noa>] [B<-loc>] [B<-v>] [B<-en>] [B<-nor>]
- S<<< [B<-co> <I<config directory>>] >>>
- [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos listvol> command formats and displays the following information
-from the volume header of each specified volume: volume name, volume ID,
-volume type, size, and status at the server. The actual information
-displayed depends on the combination of arguments supplied when the
-command is issued. To display volume header information for various
-numbers of volumes, combine the command's arguments as indicated:
-
-=over 4
-
-=item *
-
-For every volume on a file server machine, specify the machine's name with
-the B<-server> argument.
-
-=item *
-
-For every volume at a particular site, combine the B<-server> argument
-with the B<-partition> argument.
-
-=back
-
-To display the Volume Location Database (VLDB) entry for one or more
-volumes, use the B<vos listvldb> command. To display both the VLDB entry
-and the volume header for a single volume, use the B<vos examine> command.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-server> <I<server name>>
-
-Identifies the file server machine that houses volumes for which to
-display the header. Provide the machine's IP address or its host name
-(either fully qualified or using an unambiguous abbreviation). For
-details, see L<vos(1)>.
-
-This argument can be combined with the B<-partition> argument, as well as
-the B<-fast>, B<-long>, or B<-extended> flag.
-
-=item B<-partition> <I<partition name>>
-
-Identifies the partition (on the file server machine specified by the
-B<-server> argument) that houses volumes for which to display the
-header. Provide the partition's complete name with preceding slash (for
-example, F</vicepa>) or use one of the three acceptable abbreviated
-forms. For details, see L<vos(1)>.
-
-=item B<-fast>
-
-Displays only the volume ID numbers of volumes stored at the site
-specified by the B<-server>, and optionally B<-partition>, argument. Do
-not combine this flag with the B<-extended> flag.
-
-=item B<-long>
-
-Displays more detailed information about each volume stored at the site
-specified by the B<-server>, and optionally B<-partition>, argument. The
-information includes the volume IDs of all three volume types associated
-with the volume, and the read/write volume's quota, creation date and
-update date.
-
-=item B<-quiet>
-
-Suppresses the lines that summarize the number of volumes listed and their
-status, which otherwise appear at the beginning and end of the output when
-the output includes more than one volume.
-
-=item B<-extended>
-
-Displays extensive statistics about access patterns for each volume stored
-at the site specified by the B<-server>, and optionally B<-partition>,
-argument. The statistics include the number of reads and writes to files
-in the volume, and how recently files and directories have been updated by
-their owners or other users. Do not combine this flag with the B<-fast>
-flag.
-
-=item B<-format>
-
-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.
-
-=back
-
-=head1 OUTPUT
-
-The output is ordered alphabetically by volume name and by default
-provides the following information on a single line for each volume:
-
-=over 4
-
-=item *
-
-Name
-
-=item *
-
-Volume ID number
-
-=item *
-
-Type (the flag is C<RW> for read/write, C<RO> for read-only, C<BK> for
-backup)
-
-=item *
-
-Size in kilobytes (C<1024> equals a megabyte)
-
-=item *
-
-Number of files in the volume, if the B<-extended> flag is provided
-
-=item *
-
-Status on the file server machine, which is one of the following:
-
-=over 4
-
-=item On-line
-
-The volume is completely accessible to Cache Managers.
-
-=item Off-line
-
-The volume is not accessible to Cache Managers, but does not seem to be
-corrupted. This status appears while a volume is being dumped, for
-example.
-
-=item Off-line**needs salvage**
-
-The volume is not accessible to Cache Managers, because it seems to be
-corrupted. Use the B<bos salvage> or B<salvager> command to repair the
-corruption.
-
-=back
-
-=back
-
-If the following message appears instead of the previously listed
-information, it indicates that a volume is not accessible to Cache
-Managers or the B<vos> command interpreter, for example because a clone is
-being created.
-
- **** Volume <volume_ID> is busy ****
-
-If the following message appears instead of the previously listed
-information, it indicates that the File Server is unable to attach the
-volume, perhaps because it is seriously corrupted. The F<FileLog> and
-F<VolserLog> log files in the F</usr/afs/logs> directory on the file
-server machine possibly provide additional information; use the B<bos
-getlog> command to display them.
-
- **** Could not attach volume <volume_ID> ****
-
-The information about individual volumes is bracketed by summary
-lines. The first line of output specifies the number of volumes in the
-listing. The last line of output summarizes the number of volumes that are
-online, offline, and busy. These lines do not appear if the B<-quiet> flag
-is used.
-
-If the B<-fast> flag is added, the output displays only the volume ID
-number of each volume, arranged in increasing numerical order. The final
-line (which summarizes the number of online, offline, and busy volumes) is
-omitted.
-
-If the B<-long> flag is included, the output for each volume includes all
-of the information in the default listing plus the following. Each item in
-this list corresponds to a separate line of output:
-
-=over 4
-
-=item *
-
-The file server machine and partition that house the volume, as determined
-by the command interpreter as the command runs, rather than derived from the
-VLDB or the volume header.
-
-=item *
-
-The volume ID numbers associated with the various versions of the volume:
-read/write (C<RWrite>), read-only (C<ROnly>), backup (C<Backup>), and
-ReleaseClone (C<RClone>). One of them matches the volume ID number that
-appears on the first line of the volume's output. If the value in the
-C<RWrite>, C<ROnly>, or C<Backup> field is C<0> (zero), there is no volume
-of that type. If there is currently no ReleaseClone, the C<RClone> field
-does not appear at all.
-
-=item *
-
-The maximum space quota allotted to the read/write copy of the volume,
-expressed in kilobyte blocks in the C<MaxQuota> field.
-
-=item *
-
-The date and time the volume was created, in the C<Creation> field. If the
-volume has been restored with the B<backup diskrestore>, B<backup
-volrestore>, or B<vos restore> command, this is the restore time.
-
-=item *
-
-The date and time when the contents of the volume last changed, in the
-C<Last Update> field. For read-only and backup volumes, it matches the
-timestamp in the C<Creation> field.
-
-=item *
-
-The number of times the volume has been accessed for a fetch or store
-operation since the later of the two following times:
-
-=over 4
-
-=item *
-
-12:00 a.m. on the day the command is issued
-
-=item *
-
-The last time the volume changed location
-
-=back
-
-=back
-
-If the B<-extended> flag is included, the output for each volume includes
-all of the information reported with the B<-long> flag, plus two tables of
-statistics:
-
-=over 4
-
-=item *
-
-The table labeled C<Raw Read/Write Stats> table summarizes the number of
-times the volume has been accessed for reading or writing.
-
-=item *
-
-The table labeled C<Writes Affecting Authorship> table contains
-information on writes made to files and directories in the specified
-volume.
-
-=back
-
-=head1 EXAMPLES
-
-The following example shows the output for the F</vicepb> partition on the
-file server machine C<fs2.example.com> when no flags are provided:
-
- % vos listvol -server fs2.example.com -partition b
- Total number of volumes on server fs2.example.com partition /vicepb : 66
- sys 1969534847 RW 1582 K On-line
- sys.backup 1969535105 BK 1582 K On-line
- . . . . . .
- . . . . . .
- user.pat 1969534536 RW 17518 K On-line
- user.pat.backup 1969534538 BK 17537 K On-line
- Total volumes onLine 66 ; Total volumes offLine 0 ; Total busy 0
-
-The following example shows the output when the B<-fast> flag is added:
-
- % vos listvol -server fs2.example.com -partition b -fast
- Total number of volumes on server fs2.example.com partition /vicepb : 66
- 1969516782
- 1969516784
- .
- .
- 1969535796
-
-The following example shows two volumes from the output that appears when
-the B<-long> flag is added:
-
- % vos listvol -server fs2.example.com -partition b -long
- Total number of volumes on server fs2.example.com partition /vicepb: 66
- . . . . . .
- . . . . . .
- user.pat 1969534536 RW 17518 K On-line
- fs2.example.com /vicepb
- RWrite 1969534536 ROnly 0 Backup 1969534538
- MaxQuota 20000 K
- Creation Mon Jun 12 09:02:25 1989
- Last Update Thu May 20 17:39:34 1999
- 1573 accesses in the past day (i.e., vnode references)
- user.pat.backup 1969534538 BK 17537 K On-line
- fs2.example.com /vicepb
- RWrite 1969534536 ROnly 0 Backup 1969534538
- MaxQuota 20000 K
- Creation Tue Jun 13 04:37:59 1989
- Last Update Wed May 19 06:37:59 1999
- 0 accesses in the past day (i.e., vnode references)
- . . . . . .
- . . . . . .
- Total volumes onLine 66 ; Total volumes offLine 0 ; Total busy 0
-
-=head1 PRIVILEGE REQUIRED
-
-None
-
-=head1 SEE ALSO
-
-L<backup_diskrestore(8)>,
-L<backup_volrestore(8)>,
-L<bos_getlog(8)>,
-L<bos_salvage(8)>,
-L<salvager(8)>,
-L<vos(1)>,
-L<vos_examine(1)>,
-L<vos_listvldb(1)>,
-L<vos_restore(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.
--- /dev/null
+=head1 NAME
+
+vos_listvol - Displays information from a volume header
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos listvol> S<<< B<-server> <I<machine name>> >>>
+ S<<< [B<-partition> <I<partition name>>] >>>
+ [B<-fast>] [B<-long>] [B<-quiet>]
+ [B<-extended>] [B<-format>]
+ 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 listvo> S<<< B<-s> <I<machine name>> >>>
+ S<<< [B<-p> <I<partition name>>] >>>
+ [B<-fa>] [-lon] [B<-q>] [B<-ex>] [B<-fo>]
+ S<<< [B<-c> <I<cell name>>] >>>
+ [B<-noa>] [B<-loc>] [B<-v>] [B<-en>] [B<-nor>]
+ S<<< [B<-co> <I<config directory>>] >>>
+ [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos listvol> command formats and displays the following information
+from the volume header of each specified volume: volume name, volume ID,
+volume type, size, and status at the server. The actual information
+displayed depends on the combination of arguments supplied when the
+command is issued. To display volume header information for various
+numbers of volumes, combine the command's arguments as indicated:
+
+=over 4
+
+=item *
+
+For every volume on a file server machine, specify the machine's name with
+the B<-server> argument.
+
+=item *
+
+For every volume at a particular site, combine the B<-server> argument
+with the B<-partition> argument.
+
+=back
+
+To display the Volume Location Database (VLDB) entry for one or more
+volumes, use the B<vos listvldb> command. To display both the VLDB entry
+and the volume header for a single volume, use the B<vos examine> command.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-server> <I<server name>>
+
+Identifies the file server machine that houses volumes for which to
+display the header. Provide the machine's IP address or its host name
+(either fully qualified or using an unambiguous abbreviation). For
+details, see L<vos(1)>.
+
+This argument can be combined with the B<-partition> argument, as well as
+the B<-fast>, B<-long>, or B<-extended> flag.
+
+=item B<-partition> <I<partition name>>
+
+Identifies the partition (on the file server machine specified by the
+B<-server> argument) that houses volumes for which to display the
+header. Provide the partition's complete name with preceding slash (for
+example, F</vicepa>) or use one of the three acceptable abbreviated
+forms. For details, see L<vos(1)>.
+
+=item B<-fast>
+
+Displays only the volume ID numbers of volumes stored at the site
+specified by the B<-server>, and optionally B<-partition>, argument. Do
+not combine this flag with the B<-extended> flag.
+
+=item B<-long>
+
+Displays more detailed information about each volume stored at the site
+specified by the B<-server>, and optionally B<-partition>, argument. The
+information includes the volume IDs of all three volume types associated
+with the volume, and the read/write volume's quota, creation date and
+update date.
+
+=item B<-quiet>
+
+Suppresses the lines that summarize the number of volumes listed and their
+status, which otherwise appear at the beginning and end of the output when
+the output includes more than one volume.
+
+=item B<-extended>
+
+Displays extensive statistics about access patterns for each volume stored
+at the site specified by the B<-server>, and optionally B<-partition>,
+argument. The statistics include the number of reads and writes to files
+in the volume, and how recently files and directories have been updated by
+their owners or other users. Do not combine this flag with the B<-fast>
+flag.
+
+=item B<-format>
+
+Show information in a format suitable for machine parsing.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 OUTPUT
+
+The output is ordered alphabetically by volume name and by default
+provides the following information on a single line for each volume:
+
+=over 4
+
+=item *
+
+Name
+
+=item *
+
+Volume ID number
+
+=item *
+
+Type (the flag is C<RW> for read/write, C<RO> for read-only, C<BK> for
+backup)
+
+=item *
+
+Size in kilobytes (C<1024> equals a megabyte)
+
+=item *
+
+Number of files in the volume, if the B<-extended> flag is provided
+
+=item *
+
+Status on the file server machine, which is one of the following:
+
+=over 4
+
+=item On-line
+
+The volume is completely accessible to Cache Managers.
+
+=item Off-line
+
+The volume is not accessible to Cache Managers, but does not seem to be
+corrupted. This status appears while a volume is being dumped, for
+example.
+
+=item Off-line**needs salvage**
+
+The volume is not accessible to Cache Managers, because it seems to be
+corrupted. Use the B<bos salvage> or B<salvager> command to repair the
+corruption.
+
+=back
+
+=back
+
+If the following message appears instead of the previously listed
+information, it indicates that a volume is not accessible to Cache
+Managers or the B<vos> command interpreter, for example because a clone is
+being created.
+
+ **** Volume <volume_ID> is busy ****
+
+If the following message appears instead of the previously listed
+information, it indicates that the File Server is unable to attach the
+volume, perhaps because it is seriously corrupted. The F<FileLog> and
+F<VolserLog> log files in the F</usr/afs/logs> directory on the file
+server machine possibly provide additional information; use the B<bos
+getlog> command to display them.
+
+ **** Could not attach volume <volume_ID> ****
+
+The information about individual volumes is bracketed by summary
+lines. The first line of output specifies the number of volumes in the
+listing. The last line of output summarizes the number of volumes that are
+online, offline, and busy. These lines do not appear if the B<-quiet> flag
+is used.
+
+If the B<-fast> flag is added, the output displays only the volume ID
+number of each volume, arranged in increasing numerical order. The final
+line (which summarizes the number of online, offline, and busy volumes) is
+omitted.
+
+If the B<-long> flag is included, the output for each volume includes all
+of the information in the default listing plus the following. Each item in
+this list corresponds to a separate line of output:
+
+=over 4
+
+=item *
+
+The file server machine and partition that house the volume, as determined
+by the command interpreter as the command runs, rather than derived from the
+VLDB or the volume header.
+
+=item *
+
+The volume ID numbers associated with the various versions of the volume:
+read/write (C<RWrite>), read-only (C<ROnly>), backup (C<Backup>), and
+ReleaseClone (C<RClone>). One of them matches the volume ID number that
+appears on the first line of the volume's output. If the value in the
+C<RWrite>, C<ROnly>, or C<Backup> field is C<0> (zero), there is no volume
+of that type. If there is currently no ReleaseClone, the C<RClone> field
+does not appear at all.
+
+=item *
+
+The maximum space quota allotted to the read/write copy of the volume,
+expressed in kilobyte blocks in the C<MaxQuota> field.
+
+=item *
+
+The date and time the volume was created, in the C<Creation> field. If the
+volume has been restored with the B<backup diskrestore>, B<backup
+volrestore>, or B<vos restore> command, this is the restore time.
+
+=item *
+
+The date and time when the contents of the volume last changed, in the
+C<Last Update> field. For read-only and backup volumes, it matches the
+timestamp in the C<Creation> field.
+
+=item *
+
+The number of times the volume has been accessed for a fetch or store
+operation since the later of the two following times:
+
+=over 4
+
+=item *
+
+12:00 a.m. on the day the command is issued
+
+=item *
+
+The last time the volume changed location
+
+=back
+
+=back
+
+If the B<-extended> flag is included, the output for each volume includes
+all of the information reported with the B<-long> flag, plus two tables of
+statistics:
+
+=over 4
+
+=item *
+
+The table labeled C<Raw Read/Write Stats> table summarizes the number of
+times the volume has been accessed for reading or writing.
+
+=item *
+
+The table labeled C<Writes Affecting Authorship> table contains
+information on writes made to files and directories in the specified
+volume.
+
+=back
+
+=head1 EXAMPLES
+
+The following example shows the output for the F</vicepb> partition on the
+file server machine C<fs2.example.com> when no flags are provided:
+
+ % vos listvol -server fs2.example.com -partition b
+ Total number of volumes on server fs2.example.com partition /vicepb : 66
+ sys 1969534847 RW 1582 K On-line
+ sys.backup 1969535105 BK 1582 K On-line
+ . . . . . .
+ . . . . . .
+ user.pat 1969534536 RW 17518 K On-line
+ user.pat.backup 1969534538 BK 17537 K On-line
+ Total volumes onLine 66 ; Total volumes offLine 0 ; Total busy 0
+
+The following example shows the output when the B<-fast> flag is added:
+
+ % vos listvol -server fs2.example.com -partition b -fast
+ Total number of volumes on server fs2.example.com partition /vicepb : 66
+ 1969516782
+ 1969516784
+ .
+ .
+ 1969535796
+
+The following example shows two volumes from the output that appears when
+the B<-long> flag is added:
+
+ % vos listvol -server fs2.example.com -partition b -long
+ Total number of volumes on server fs2.example.com partition /vicepb: 66
+ . . . . . .
+ . . . . . .
+ user.pat 1969534536 RW 17518 K On-line
+ fs2.example.com /vicepb
+ RWrite 1969534536 ROnly 0 Backup 1969534538
+ MaxQuota 20000 K
+ Creation Mon Jun 12 09:02:25 1989
+ Last Update Thu May 20 17:39:34 1999
+ 1573 accesses in the past day (i.e., vnode references)
+ user.pat.backup 1969534538 BK 17537 K On-line
+ fs2.example.com /vicepb
+ RWrite 1969534536 ROnly 0 Backup 1969534538
+ MaxQuota 20000 K
+ Creation Tue Jun 13 04:37:59 1989
+ Last Update Wed May 19 06:37:59 1999
+ 0 accesses in the past day (i.e., vnode references)
+ . . . . . .
+ . . . . . .
+ Total volumes onLine 66 ; Total volumes offLine 0 ; Total busy 0
+
+=head1 PRIVILEGE REQUIRED
+
+None
+
+=head1 SEE ALSO
+
+L<backup_diskrestore(8)>,
+L<backup_volrestore(8)>,
+L<bos_getlog(8)>,
+L<bos_salvage(8)>,
+L<salvager(8)>,
+L<vos(1)>,
+L<vos_examine(1)>,
+L<vos_listvldb(1)>,
+L<vos_restore(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.
+++ /dev/null
-=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.
--- /dev/null
+=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.
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
+++ /dev/null
-=head1 NAME
-
-vos_offline - Takes a volume offline
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos offline> S<<< B<-server> <I<machine name>> >>>
- S<<< B<-partition> <I<partition name>> >>>
- S<<< B<-id> <I<volume name or ID>> >>>
- S<<< [B<-sleep> <I<seconds to sleep>>] >>>
- [B<-busy>] 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 of> S<<< B<-se> <I<machine name>> >>>
- S<<< B<-p> <I<partition name>> >>>
- S<<< B<-i> <I<volume name or ID>> >>>
- S<<< [B<-sl> <I<seconds to sleep>>] >>>
- [B<-b>] 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 offline> command takes a volume offline on the
-B<fileserver>.
-
-=head1 CAUTIONS
-
-Taking a volume offline that has existing
-callbacks will result in those callbacks being broken
-and clients not being able to access the volume.
-
-=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<-sleep> <I<seconds to sleep>>
-
-Specifies to sleep for a certain number of seconds after taking the
-volume offline before bringing it online again. If this option is
-specified, the volume will be online when B<vos offline> successfully
-completes. If this option is not specified, B<vos online> must be run to
-bring the volume online.
-
-=item B<-busy>
-
-Specifies to mark the volume as `busy' instead of `offline'. This
-means that a program trying to access this volume will receive a VBUSY
-error instead of a VOFFLINE error (until the volume is brought back
-online).
-
-Different programs may react differently when they see these two
-different states, but in general a `busy' volume is only unavailable
-for a short period of time and will become online soon. An `offline'
-volume, on the other hand, is typically unavailable for longer periods
-and may not come back online until an administrator intervenes.
-
-As an example of when these states occur normally, a volume can be
-`busy' when it is being cloned (perhaps as the result of a
-B<vos backup> or B<vos release> operation). A volume can be `offline'
-if a non-DAFS fileserver has detected a problem in the volume, and an
-administrator must manually schedule a salvage for that volume before
-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.
-
-=back
-
-=head1 EXAMPLES
-
-The following example takes an online volume offline:
-
- % vos offline -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_online(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.
--- /dev/null
+=head1 NAME
+
+vos_offline - Takes a volume offline
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos offline> S<<< B<-server> <I<machine name>> >>>
+ S<<< B<-partition> <I<partition name>> >>>
+ S<<< B<-id> <I<volume name or ID>> >>>
+ S<<< [B<-sleep> <I<seconds to sleep>>] >>>
+ [B<-busy>] 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 of> S<<< B<-se> <I<machine name>> >>>
+ S<<< B<-p> <I<partition name>> >>>
+ S<<< B<-i> <I<volume name or ID>> >>>
+ S<<< [B<-sl> <I<seconds to sleep>>] >>>
+ [B<-b>] 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 offline> command takes a volume offline on the
+B<fileserver>.
+
+=head1 CAUTIONS
+
+Taking a volume offline that has existing
+callbacks will result in those callbacks being broken
+and clients not being able to access the volume.
+
+=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<-sleep> <I<seconds to sleep>>
+
+Specifies to sleep for a certain number of seconds after taking the
+volume offline before bringing it online again. If this option is
+specified, the volume will be online when B<vos offline> successfully
+completes. If this option is not specified, B<vos online> must be run to
+bring the volume online.
+
+=item B<-busy>
+
+Specifies to mark the volume as `busy' instead of `offline'. This
+means that a program trying to access this volume will receive a VBUSY
+error instead of a VOFFLINE error (until the volume is brought back
+online).
+
+Different programs may react differently when they see these two
+different states, but in general a `busy' volume is only unavailable
+for a short period of time and will become online soon. An `offline'
+volume, on the other hand, is typically unavailable for longer periods
+and may not come back online until an administrator intervenes.
+
+As an example of when these states occur normally, a volume can be
+`busy' when it is being cloned (perhaps as the result of a
+B<vos backup> or B<vos release> operation). A volume can be `offline'
+if a non-DAFS fileserver has detected a problem in the volume, and an
+administrator must manually schedule a salvage for that volume before
+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.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following example takes an online volume offline:
+
+ % vos offline -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_online(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.
+++ /dev/null
-=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.
--- /dev/null
+=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.
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
+++ /dev/null
-=head1 NAME
-
-vos_release - Updates read-only volumes to match the read/write source volume
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos release> S<<< B<-id> <I<volume name or ID>> >>> [B<-force>]
- S<<< [B<-cell> <I<cell name>>] >>>
- [B<-noauth>] [B<-localauth>] [B<-stayonline>]
- [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
- S<<< [B<-config> <I<config directory>>] >>>
- [B<-help>]
-
-B<vos rel> S<<< B<-i> <I<volume name or ID>> >>>
- [B<-f>] S<<< [B<-c> <I<cell name>>] >>> [B<-stayon>]
- [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 release> command copies the contents of the indicated read/write
-source volume to each read-only site defined in the source volume's Volume
-Location Database (VLDB) entry. (Use the B<vos addsite> command to define
-sites as necessary before issuing this command). Each read-only copy has
-the same name as read/write source with the addition of a C<.readonly>
-extension.
-
-For users to have a consistent view of the file system, the release of the
-new volume version must be atomic: either all read-only sites receive the
-new version, or all sites keep the version they currently have. The B<vos
-release> command is designed to ensure that all copies of the volume's
-read-only version match both the read/write source and each other. In
-cases where problems such as machine or server process outages prevent
-successful completion of the release operation, AFS uses two mechanisms to
-alert the administrator.
-
-First, the command interpreter generates an error message on the standard
-error stream naming each read-only site that did not receive the new
-volume version. Second, during the release operation the Volume Location
-(VL) Server marks site definitions in the VLDB entry with flags (C<New
-release> and C<Old release>) that indicate whether or not the site has the
-new volume version. If any flags remain after the operation completes, it
-was not successful. The Cache Manager refuses to access a read-only site
-marked with the C<Old release> flag, which potentially imposes a greater
-load on the sites marked with the C<New release> flag. It is important to
-investigate and eliminate the cause of the failure and then to issue the
-B<vos release> command as many times as necessary to complete the release
-without errors.
-
-The pattern of site flags remaining in the volume's VLDB entry after a
-failed release operation can help determine the point at which the
-operation failed. Use the B<vos examine> or B<vos listvldb> command to
-display the VLDB entry. The VL Server sets the flags in concert with the
-Volume Server's operations, as follows:
-
-=over 4
-
-=item *
-
-Before the operation begins, the VL Server sets the C<New release> flag on
-the read/write site definition in the VLDB entry and the C<Old release>
-flag on read-only site definitions (unless the read-only site has been
-defined since the last release operation and has no actual volume, in
-which case its site flag remains C<Not released>).
-
-=item *
-
-If necessary, the Volume Server creates a temporary copy (a I<clone>) of
-the read/write source called the ReleaseClone (see the following
-discussion of when the Volume Server does or does not create a new
-ReleaseClone.) It assigns the ReleaseClone its own volume ID number, which
-the VL Server records in the C<RClone> field of the source volume's VLDB
-entry.
-
-=item *
-
-The Volume Server distributes a copy of the ReleaseClone to each read-only
-site defined in the VLDB entry. As the site successfully receives the new
-clone, the VL Server sets the site's flag in the VLDB entry to C<New
-release>.
-
-=item *
-
-When all the read-only copies are successfully released, the VL Server
-clears all the C<New release> site flags. The ReleaseClone is no longer
-needed, so the Volume Server deletes it and the VL Server erases its ID
-from the VLDB entry.
-
-=back
-
-By default, the Volume Server determines automatically whether or not it
-needs to create a new ReleaseClone:
-
-=over 4
-
-=item *
-
-If there are no flags (C<New release>, C<Old release>, or C<Not released>)
-on site definitions in the VLDB entry, the previous B<vos release> command
-completed successfully and all read-only sites currently have the same
-volume. The Volume Server infers that the current B<vos release> command
-was issued because the read/write volume has changed. The Volume Server
-creates a new ReleaseClone and distributes it to all of the read-only
-sites.
-
-=item *
-
-If any site definition in the VLDB entry is marked with a flag, either the
-previous release operation did not complete successfully or a new
-read-only site was defined since the last release. The Volume Server does
-not create a new ReleaseClone, instead distributing the existing
-ReleaseClone to sites marked with the C<Old release> or C<Not released>
-flag. As previously noted, the VL Server marks each VLDB site definition
-with the C<New release> flag as the site receives the ReleaseClone, and
-clears all flags after all sites successfully receive it.
-
-=back
-
-To override the default behavior, forcing the Volume Server to create and
-release a new ReleaseClone to the read-only sites, include the B<-force>
-flag. This is appropriate if, for example, the data at the read/write site
-has changed since the existing ReleaseClone was created during the
-previous release operation.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-id> <I<volume name or id>>
-
-Specifies either the complete name or volume ID number of a read/write
-volume.
-
-=item B<-force>
-
-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.
-
-=back
-
-=head1 EXAMPLES
-
-The following command clones the read/write volume usr and releases it to
-the read-only sites defined in its VLDB entry.
-
- % vos release usr
-
-=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_addsite(1)>,
-L<vos_examine(1)>,
-L<vos_listvldb(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.
--- /dev/null
+=head1 NAME
+
+vos_release - Updates read-only volumes to match the read/write source volume
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos release> S<<< B<-id> <I<volume name or ID>> >>> [B<-force>]
+ S<<< [B<-cell> <I<cell name>>] >>>
+ [B<-noauth>] [B<-localauth>] [B<-stayonline>]
+ [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
+ S<<< [B<-config> <I<config directory>>] >>>
+ [B<-help>]
+
+B<vos rel> S<<< B<-i> <I<volume name or ID>> >>>
+ [B<-f>] S<<< [B<-c> <I<cell name>>] >>> [B<-stayon>]
+ [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 release> command copies the contents of the indicated read/write
+source volume to each read-only site defined in the source volume's Volume
+Location Database (VLDB) entry. (Use the B<vos addsite> command to define
+sites as necessary before issuing this command). Each read-only copy has
+the same name as read/write source with the addition of a C<.readonly>
+extension.
+
+For users to have a consistent view of the file system, the release of the
+new volume version must be atomic: either all read-only sites receive the
+new version, or all sites keep the version they currently have. The B<vos
+release> command is designed to ensure that all copies of the volume's
+read-only version match both the read/write source and each other. In
+cases where problems such as machine or server process outages prevent
+successful completion of the release operation, AFS uses two mechanisms to
+alert the administrator.
+
+First, the command interpreter generates an error message on the standard
+error stream naming each read-only site that did not receive the new
+volume version. Second, during the release operation the Volume Location
+(VL) Server marks site definitions in the VLDB entry with flags (C<New
+release> and C<Old release>) that indicate whether or not the site has the
+new volume version. If any flags remain after the operation completes, it
+was not successful. The Cache Manager refuses to access a read-only site
+marked with the C<Old release> flag, which potentially imposes a greater
+load on the sites marked with the C<New release> flag. It is important to
+investigate and eliminate the cause of the failure and then to issue the
+B<vos release> command as many times as necessary to complete the release
+without errors.
+
+The pattern of site flags remaining in the volume's VLDB entry after a
+failed release operation can help determine the point at which the
+operation failed. Use the B<vos examine> or B<vos listvldb> command to
+display the VLDB entry. The VL Server sets the flags in concert with the
+Volume Server's operations, as follows:
+
+=over 4
+
+=item *
+
+Before the operation begins, the VL Server sets the C<New release> flag on
+the read/write site definition in the VLDB entry and the C<Old release>
+flag on read-only site definitions (unless the read-only site has been
+defined since the last release operation and has no actual volume, in
+which case its site flag remains C<Not released>).
+
+=item *
+
+If necessary, the Volume Server creates a temporary copy (a I<clone>) of
+the read/write source called the ReleaseClone (see the following
+discussion of when the Volume Server does or does not create a new
+ReleaseClone.) It assigns the ReleaseClone its own volume ID number, which
+the VL Server records in the C<RClone> field of the source volume's VLDB
+entry.
+
+=item *
+
+The Volume Server distributes a copy of the ReleaseClone to each read-only
+site defined in the VLDB entry. As the site successfully receives the new
+clone, the VL Server sets the site's flag in the VLDB entry to C<New
+release>.
+
+=item *
+
+When all the read-only copies are successfully released, the VL Server
+clears all the C<New release> site flags. The ReleaseClone is no longer
+needed, so the Volume Server deletes it and the VL Server erases its ID
+from the VLDB entry.
+
+=back
+
+By default, the Volume Server determines automatically whether or not it
+needs to create a new ReleaseClone:
+
+=over 4
+
+=item *
+
+If there are no flags (C<New release>, C<Old release>, or C<Not released>)
+on site definitions in the VLDB entry, the previous B<vos release> command
+completed successfully and all read-only sites currently have the same
+volume. The Volume Server infers that the current B<vos release> command
+was issued because the read/write volume has changed. The Volume Server
+creates a new ReleaseClone and distributes it to all of the read-only
+sites.
+
+=item *
+
+If any site definition in the VLDB entry is marked with a flag, either the
+previous release operation did not complete successfully or a new
+read-only site was defined since the last release. The Volume Server does
+not create a new ReleaseClone, instead distributing the existing
+ReleaseClone to sites marked with the C<Old release> or C<Not released>
+flag. As previously noted, the VL Server marks each VLDB site definition
+with the C<New release> flag as the site receives the ReleaseClone, and
+clears all flags after all sites successfully receive it.
+
+=back
+
+To override the default behavior, forcing the Volume Server to create and
+release a new ReleaseClone to the read-only sites, include the B<-force>
+flag. This is appropriate if, for example, the data at the read/write site
+has changed since the existing ReleaseClone was created during the
+previous release operation.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-id> <I<volume name or id>>
+
+Specifies either the complete name or volume ID number of a read/write
+volume.
+
+=item B<-force>
+
+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<-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.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following command clones the read/write volume usr and releases it to
+the read-only sites defined in its VLDB entry.
+
+ % vos release usr
+
+=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_addsite(1)>,
+L<vos_examine(1)>,
+L<vos_listvldb(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.
+++ /dev/null
-=head1 NAME
-
-vos_remove - Removes a volume from a site
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos remove> 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 remo> 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 remove> command removes the indicated volume from the partition
-on which it resides. The Volume Location Database (VLDB) record is altered
-appropriately, as described in the following paragraphs. Use this command
-to remove any of the three types of volumes; the effect depends on the
-type.
-
-=over 4
-
-=item *
-
-If the B<-id> argument names the read/write volume (that is, specifies the
-volume's base name), both it and the associated backup volume are removed
-from the partition that houses them. The B<-server> and B<-partition>
-arguments are optional, because there can be only one read/write
-site. When the volume is removed, the site information is also removed
-from the VLDB entry. The read/write and backup volume ID numbers no longer
-appear in the output from the B<vos listvldb> or B<vos examine> commands,
-but they are preserved internally. Read-only sites, if any, are not
-affected, but cannot be changed unless a read/write site is again
-defined. The site count reported by the B<vos examine> and B<vos listvldb>
-commands as C<number of sites> decrements by one. The entire VLDB entry is
-removed if there are no read-only sites.
-
-=item *
-
-If the B<-id> argument names a read-only volume, it is removed from the
-partition that houses it, and the corresponding site information is
-removed from the VLDB entry. The site count reported by the B<vos examine>
-and B<vos listvldb> commands as C<number of sites> decrements by one for
-each volume you remove. If there is more than one read-only site, the
-B<-server> argument (and optionally B<-partition> argument) must be used
-to specify the site from which to remove the volume. If there is only one
-read-only site, the B<-id> argument is sufficient; if there is also no
-read/write volume in this case, the entire VLDB entry is removed.
-
-=item *
-
-If the B<-id> argument names a backup volume, it is removed from the
-partition that houses it. The B<-server> and B<-partition> arguments are
-optional, because there can be only one backup site. The backup volume ID
-number no longer appears in the output from the B<vos listvldb> command or
-in the corresponding portion of the output from the B<vos examine>
-command, but is preserved internally.
-
-=back
-
-This command is the most appropriate one for removing volumes in almost
-all cases. Other commands that remove only volumes or only VLDB entries
-(such as the B<vos delentry>, B<vos remsite> and B<vos zap> commands) by
-definition can put the volumes and VLDB out of sync. Use them only in the
-special circumstances mentioned on their reference pages. Like the B<vos
-delentry> command, this command can remove a VLDB entry when no
-corresponding volumes exist on the file server machine. Like the B<vos
-zap> command, this command can remove a volume that does not have a VLDB
-entry, as long as the volume is online, B<-server> and B<-partition>
-arguments are provided, and the B<-id> argument specifies the volume's ID
-number.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-server> <I<server name>>
-
-Identifies the file server machine that houses the volume to remove. It is
-necessary only when the B<-id> argument names a read-only volume that
-exists at multiple sites. 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 specified by the
-B<-server> argument) that houses the volume to remove. 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)>.
-
-Including this argument is necessary only when the B<-id> argument names a
-read-only volume that exists at multiple sites. Provide the B<-server>
-argument along with this one.
-
-=item B<-id> <I<volume name or id>>
-
-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.
-
-=back
-
-=head1 EXAMPLES
-
-The following example removes the read/write volume C<user.terry> and its
-backup version, if any.
-
- % vos remove -id user.terry
-
-The following example removes the read-only volume C<root.afs.readonly>
-from one of its sites, the F</vicepa> partition on the file server machine
-C<fs1.example.com>.
-
- % vos remove fs1.example.com a root.afs.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)>,
-L<vos_delentry(1)>,
-L<vos_remsite(1)>,
-L<vos_zap(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.
--- /dev/null
+=head1 NAME
+
+vos_remove - Removes a volume from a site
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos remove> 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 remo> 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 remove> command removes the indicated volume from the partition
+on which it resides. The Volume Location Database (VLDB) record is altered
+appropriately, as described in the following paragraphs. Use this command
+to remove any of the three types of volumes; the effect depends on the
+type.
+
+=over 4
+
+=item *
+
+If the B<-id> argument names the read/write volume (that is, specifies the
+volume's base name), both it and the associated backup volume are removed
+from the partition that houses them. The B<-server> and B<-partition>
+arguments are optional, because there can be only one read/write
+site. When the volume is removed, the site information is also removed
+from the VLDB entry. The read/write and backup volume ID numbers no longer
+appear in the output from the B<vos listvldb> or B<vos examine> commands,
+but they are preserved internally. Read-only sites, if any, are not
+affected, but cannot be changed unless a read/write site is again
+defined. The site count reported by the B<vos examine> and B<vos listvldb>
+commands as C<number of sites> decrements by one. The entire VLDB entry is
+removed if there are no read-only sites.
+
+=item *
+
+If the B<-id> argument names a read-only volume, it is removed from the
+partition that houses it, and the corresponding site information is
+removed from the VLDB entry. The site count reported by the B<vos examine>
+and B<vos listvldb> commands as C<number of sites> decrements by one for
+each volume you remove. If there is more than one read-only site, the
+B<-server> argument (and optionally B<-partition> argument) must be used
+to specify the site from which to remove the volume. If there is only one
+read-only site, the B<-id> argument is sufficient; if there is also no
+read/write volume in this case, the entire VLDB entry is removed.
+
+=item *
+
+If the B<-id> argument names a backup volume, it is removed from the
+partition that houses it. The B<-server> and B<-partition> arguments are
+optional, because there can be only one backup site. The backup volume ID
+number no longer appears in the output from the B<vos listvldb> command or
+in the corresponding portion of the output from the B<vos examine>
+command, but is preserved internally.
+
+=back
+
+This command is the most appropriate one for removing volumes in almost
+all cases. Other commands that remove only volumes or only VLDB entries
+(such as the B<vos delentry>, B<vos remsite> and B<vos zap> commands) by
+definition can put the volumes and VLDB out of sync. Use them only in the
+special circumstances mentioned on their reference pages. Like the B<vos
+delentry> command, this command can remove a VLDB entry when no
+corresponding volumes exist on the file server machine. Like the B<vos
+zap> command, this command can remove a volume that does not have a VLDB
+entry, as long as the volume is online, B<-server> and B<-partition>
+arguments are provided, and the B<-id> argument specifies the volume's ID
+number.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-server> <I<server name>>
+
+Identifies the file server machine that houses the volume to remove. It is
+necessary only when the B<-id> argument names a read-only volume that
+exists at multiple sites. 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 specified by the
+B<-server> argument) that houses the volume to remove. 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)>.
+
+Including this argument is necessary only when the B<-id> argument names a
+read-only volume that exists at multiple sites. Provide the B<-server>
+argument along with this one.
+
+=item B<-id> <I<volume name or id>>
+
+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>).
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following example removes the read/write volume C<user.terry> and its
+backup version, if any.
+
+ % vos remove -id user.terry
+
+The following example removes the read-only volume C<root.afs.readonly>
+from one of its sites, the F</vicepa> partition on the file server machine
+C<fs1.example.com>.
+
+ % vos remove fs1.example.com a root.afs.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)>,
+L<vos_delentry(1)>,
+L<vos_remsite(1)>,
+L<vos_zap(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.
+++ /dev/null
-=head1 NAME
-
-vos_remsite - Removes a read-only site definition from a VLDB entry
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos remsite> 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 rems> 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 remsite> command removes the read-only replication site
-specified by the B<-machine> and B<-partition> arguments from the Volume
-Location Database (VLDB) entry for the indicated volume, which is
-read/write.
-
-This command is useful for removing read-only sites that were mistakenly
-created with the B<vos addsite> command, before the B<vos release> command
-actually releases them. If a read-only copy already exists at the site, it
-is not affected. However, if this read-only site was the last site housing
-any version of the volume, then the entire VLDB entry is removed, even if
-a copy of the read-only version still actually exists at the site. The VL
-Server does not correct the discrepancy until the B<vos syncserv> and
-B<vos syncvldb> commands are run.
-
-=head1 CAUTIONS
-
-Do not use this command as the standard way to remove a read-only volume,
-because it can create a discrepancy between the VLDB and the volumes on
-file server machines. Use the B<vos remove> command instead.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-server> <I<server name>>
-
-Specifies the file server machine portion of the site definition to
-remove. 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>>
-
-Specifies the partition name portion of the site definition to
-remove. 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 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.
-
-=back
-
-=head1 EXAMPLES
-
-The following command removes the mistakenly defined read-only site
-F</viceph> on the file server machine C<fs5.example.com> from the VLDB entry
-for the volume C<root.cell>.
-
- % vos remsite -server fs5.example.com -partition h -id root.cell
-
-=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_delentry(1)>,
-L<vos_remove(1)>,
-L<vos_zap(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.
--- /dev/null
+=head1 NAME
+
+vos_remsite - Removes a read-only site definition from a VLDB entry
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos remsite> 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 rems> 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 remsite> command removes the read-only replication site
+specified by the B<-machine> and B<-partition> arguments from the Volume
+Location Database (VLDB) entry for the indicated volume, which is
+read/write.
+
+This command is useful for removing read-only sites that were mistakenly
+created with the B<vos addsite> command, before the B<vos release> command
+actually releases them. If a read-only copy already exists at the site, it
+is not affected. However, if this read-only site was the last site housing
+any version of the volume, then the entire VLDB entry is removed, even if
+a copy of the read-only version still actually exists at the site. The VL
+Server does not correct the discrepancy until the B<vos syncserv> and
+B<vos syncvldb> commands are run.
+
+=head1 CAUTIONS
+
+Do not use this command as the standard way to remove a read-only volume,
+because it can create a discrepancy between the VLDB and the volumes on
+file server machines. Use the B<vos remove> command instead.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-server> <I<server name>>
+
+Specifies the file server machine portion of the site definition to
+remove. 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>>
+
+Specifies the partition name portion of the site definition to
+remove. 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 read/write
+volume to remove.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following command removes the mistakenly defined read-only site
+F</viceph> on the file server machine C<fs5.example.com> from the VLDB entry
+for the volume C<root.cell>.
+
+ % vos remsite -server fs5.example.com -partition h -id root.cell
+
+=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_delentry(1)>,
+L<vos_remove(1)>,
+L<vos_zap(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.
+++ /dev/null
-=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.
--- /dev/null
+=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.
+++ /dev/null
-=head1 NAME
-
-vos_restore - Converts an ASCII dump file into an AFS volume
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos restore> S<<< B<-server> <I<machine name>> >>>
- S<<< B<-partition> <I<partition name>> >>>
- S<<< B<-name> <I<name of volume to be restored>> >>>
- S<<< [B<-file> <I<dump file>>] >>>
- S<<< [B<-id> <I<volume ID>>] >>>
- S<<< [B<-overwrite> (abort | full | incremental)] >>>
- [B<-offline>] [B<-readonly>]
- S<<< [B<-creation> (dump | keep | new)] >>>
- S<<< [B<-lastupdate> (dump | keep | new)] >>>
- [B<-nodelete>] S<<< [B<-cell> <I<cell name>>] >>>
- [B<-noauth>] [B<-localauth>]
- [-verbose] [B<-encrypt>] [B<-noresolve>]
- S<<< [B<-config> <I<config directory>>] >>>
- [B<-help>]
-
-B<vos res> S<<< B<-s> <I<machine name>> >>>
- S<<< B<-p> <I<partition name>> >>>
- S<<< B<-na> <I<name of volume to be restored>> >>>
- S<<< [B<-f> <I<dump file>>] >>>
- S<<< [B<-i> <I<volume ID>>] >>>
- S<<< [B<-ov> (a | f | i)] >>>
- [B<-of>] [B<-r>]
- S<<< [B<-cr> (d | k | n)] >>>
- S<<< [B<-la> (d | k | n)] >>>
- [B<-nod>] S<<< [B<-c> <I<cell name>>] >>>
- [B<-noa>] [B<-lo>] [B<-v>] [B<-e>] [B<-nor>]
- S<<< [B<-co> <I<config directory>>] >>>
- [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos restore> command converts a volume dump file previously created
-with the B<vos dump> command from ASCII into the volume format appropriate
-for the machine type indicated by the B<-server> argument, and restores it
-as a read/write volume to the partition named by the B<-partition>
-argument on that machine. The Volume Server assigns the volume name
-indicated with the B<-name> argument, and resets the volume's creation
-timestamp to the time at which the restore operation begins (the creation
-timestamp is stored in the volume header and reported in the C<Creation>
-field in the output from the B<vos examine> and B<vos listvol> commands.)
-
-Use the B<-file> argument to name the dump file, or omit the argument to
-provide the file via the standard input stream, presumably through a
-pipe. The pipe can be named, which enables interoperation with third-party
-backup utilities.
-
-As described in the following list, the command can create a completely
-new volume or overwrite an existing volume. In all cases, the full dump of
-the volume must be restored before any incremental dumps. If there are
-multiple incremental dump files, they must be restored in the order they
-were created.
-
-=over 4
-
-=item *
-
-To create a new read/write volume, use the B<-name> argument to specify a
-volume name that does not already exist in the Volume Location Database
-(VLDB), and the B<-server> and B<-partition> arguments to specify the new
-volume's site. It is best to omit the B<-id> argument so that the Volume
-Location (VL) Server allocates a volume ID automatically. Do not include
-the B<-overwrite> argument, because there is no existing volume to
-overwrite.
-
-=item *
-
-To overwrite an existing volume at its current site, specify its name and
-site with the B<-name>, B<-server>, and B<-partition> arguments. The
-volume retains its current volume ID number unless the B<-id> argument is
-provided. Specify the value C<f> or C<i> for the B<-overwrite> argument to
-indicate whether the dump file is full or incremental, respectively.
-
-=item *
-
-To overwrite an existing volume and move it to a new site, specify its
-name and the new site with the B<-name>, B<-server>, and B<-partition>
-arguments. The volume retains its current volume ID number unless the
-B<-id> argument is provided. The volume is removed from its original
-site. Specify the value C<f> for the B<-overwrite> argument to indicate
-that the dump file is a full dump (it is not possible to restore an
-incremental dump and move the volume at the same time).
-
-=back
-
-If the volume named by the B<-name> argument already exists and the
-B<-overwrite> argument is omitted, the command interpreter produces the
-following prompt:
-
- Do you want to do a full/incremental restore or abort? [fia](a):
-
-Respond by entering one of the following values:
-
-=over 4
-
-=item *
-
-C<f> if restoring a full dump file
-
-=item *
-
-C<i> if restoring an incremental dump file
-
-=item *
-
-C<a> or Return to cancel the restore operation
-
-=back
-
-=head1 CAUTIONS
-
-If the B<-file> argument is omitted, the issuer must provide all other
-necessary arguments, because the standard input stream is unavailable for
-responding to the command interpreter's prompts for missing
-information. In particular, the issuer must provide the B<-overwrite>
-argument if overwriting an existing volume.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-server> <I<server name>>
-
-Identifies the file server machine onto which to restore the
-volume. 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 specified by the
-B<-server> argument) onto which to restore the volume. Provide the
-partition's complete name with preceding slash (for example, F</vicepa>)
-or use one of the three acceptable abbreviated forms. For details, see
-L<vos(1)>.
-
-=item B<-name> <I<name of volume>>
-
-Specifies the name under which to restore the volume. It can be up to 22
-characters long, but cannot end with a C<.readonly> or C<.backup>
-extension. If the volume already exists, it is overwritten subject to the
-value of the B<-overwrite> argument.
-
-=item B<-file> <I<dump file>>
-
-Names the dump file to restore. Incomplete pathnames are interpreted
-relative to the current working directory. Omit this argument to provide
-the dump file via the standard input stream.
-
-=item B<-id> <I<volume ID>>
-
-Specifies the volume ID number to assign to the restored volume.
-
-=item B<-overwrite> (a | f | i)
-
-Specifies which type of dump file is being restored when overwriting an
-existing volume. Provide one of the following values:
-
-=over 4
-
-=item *
-
-C<a> to terminate the restore operation.
-
-=item *
-
-C<f> if restoring a full dump file.
-
-=item *
-
-C<i> if restoring an incremental dump file. This value is not acceptable
-if the B<-server> and B<-partition> arguments do not indicate the volume's
-current site.
-
-=back
-
-This argument is mandatory if the B<-file> argument is not provided.
-
-=item B<-offline>
-
-Leaves the new volume flagged as off-line in the volume database.
-
-=item B<-readonly>
-
-Flags the new volume as read-only in the volume database.
-
-=item B<-creation> <I<dump | keep | new>>
-
-Set the creation date of the new volume to the timestamp from the
-dumped volume (dump), from the target volume, if there is one (keep),
-or generate a new one using the current time (new).
-
-=item B<-lastupdate> <I<dump | keep | new>>
-
-Set the last updated date of the new volume to the timestamp from the
-dumped volume (dump), from the target volume, if there is one (keep),
-or generate a new one using the current time (new).
-
-=item B<-nodelete>
-
-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.
-
-=back
-
-=head1 EXAMPLES
-
-The following command restores the contents of the dump file
-F</afs/example.com/common/dumps/terry.dump> to the F</vicepc> partition on the
-file server machine C<fs3.example.com>. The restored volume is named
-C<user.terry>.
-
- % cd /afs/example.com/common/dumps
- % vos restore -file terry.dump -server fs3.example.com -partition c \
- -name 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<restorevol(1)>,
-L<vos(1)>,
-L<vos_dump(1)>,
-L<vos_examine(1)>,
-L<vos_listvol(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.
--- /dev/null
+=head1 NAME
+
+vos_restore - Converts an ASCII dump file into an AFS volume
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos restore> S<<< B<-server> <I<machine name>> >>>
+ S<<< B<-partition> <I<partition name>> >>>
+ S<<< B<-name> <I<name of volume to be restored>> >>>
+ S<<< [B<-file> <I<dump file>>] >>>
+ S<<< [B<-id> <I<volume ID>>] >>>
+ S<<< [B<-overwrite> (abort | full | incremental)] >>>
+ [B<-offline>] [B<-readonly>]
+ S<<< [B<-creation> (dump | keep | new)] >>>
+ S<<< [B<-lastupdate> (dump | keep | new)] >>>
+ [B<-nodelete>] S<<< [B<-cell> <I<cell name>>] >>>
+ [B<-noauth>] [B<-localauth>]
+ [-verbose] [B<-encrypt>] [B<-noresolve>]
+ S<<< [B<-config> <I<config directory>>] >>>
+ [B<-help>]
+
+B<vos res> S<<< B<-s> <I<machine name>> >>>
+ S<<< B<-p> <I<partition name>> >>>
+ S<<< B<-na> <I<name of volume to be restored>> >>>
+ S<<< [B<-f> <I<dump file>>] >>>
+ S<<< [B<-i> <I<volume ID>>] >>>
+ S<<< [B<-ov> (a | f | i)] >>>
+ [B<-of>] [B<-r>]
+ S<<< [B<-cr> (d | k | n)] >>>
+ S<<< [B<-la> (d | k | n)] >>>
+ [B<-nod>] S<<< [B<-c> <I<cell name>>] >>>
+ [B<-noa>] [B<-lo>] [B<-v>] [B<-e>] [B<-nor>]
+ S<<< [B<-co> <I<config directory>>] >>>
+ [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos restore> command converts a volume dump file previously created
+with the B<vos dump> command from ASCII into the volume format appropriate
+for the machine type indicated by the B<-server> argument, and restores it
+as a read/write volume to the partition named by the B<-partition>
+argument on that machine. The Volume Server assigns the volume name
+indicated with the B<-name> argument, and resets the volume's creation
+timestamp to the time at which the restore operation begins (the creation
+timestamp is stored in the volume header and reported in the C<Creation>
+field in the output from the B<vos examine> and B<vos listvol> commands.)
+
+Use the B<-file> argument to name the dump file, or omit the argument to
+provide the file via the standard input stream, presumably through a
+pipe. The pipe can be named, which enables interoperation with third-party
+backup utilities.
+
+As described in the following list, the command can create a completely
+new volume or overwrite an existing volume. In all cases, the full dump of
+the volume must be restored before any incremental dumps. If there are
+multiple incremental dump files, they must be restored in the order they
+were created.
+
+=over 4
+
+=item *
+
+To create a new read/write volume, use the B<-name> argument to specify a
+volume name that does not already exist in the Volume Location Database
+(VLDB), and the B<-server> and B<-partition> arguments to specify the new
+volume's site. It is best to omit the B<-id> argument so that the Volume
+Location (VL) Server allocates a volume ID automatically. Do not include
+the B<-overwrite> argument, because there is no existing volume to
+overwrite.
+
+=item *
+
+To overwrite an existing volume at its current site, specify its name and
+site with the B<-name>, B<-server>, and B<-partition> arguments. The
+volume retains its current volume ID number unless the B<-id> argument is
+provided. Specify the value C<f> or C<i> for the B<-overwrite> argument to
+indicate whether the dump file is full or incremental, respectively.
+
+=item *
+
+To overwrite an existing volume and move it to a new site, specify its
+name and the new site with the B<-name>, B<-server>, and B<-partition>
+arguments. The volume retains its current volume ID number unless the
+B<-id> argument is provided. The volume is removed from its original
+site. Specify the value C<f> for the B<-overwrite> argument to indicate
+that the dump file is a full dump (it is not possible to restore an
+incremental dump and move the volume at the same time).
+
+=back
+
+If the volume named by the B<-name> argument already exists and the
+B<-overwrite> argument is omitted, the command interpreter produces the
+following prompt:
+
+ Do you want to do a full/incremental restore or abort? [fia](a):
+
+Respond by entering one of the following values:
+
+=over 4
+
+=item *
+
+C<f> if restoring a full dump file
+
+=item *
+
+C<i> if restoring an incremental dump file
+
+=item *
+
+C<a> or Return to cancel the restore operation
+
+=back
+
+=head1 CAUTIONS
+
+If the B<-file> argument is omitted, the issuer must provide all other
+necessary arguments, because the standard input stream is unavailable for
+responding to the command interpreter's prompts for missing
+information. In particular, the issuer must provide the B<-overwrite>
+argument if overwriting an existing volume.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-server> <I<server name>>
+
+Identifies the file server machine onto which to restore the
+volume. 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 specified by the
+B<-server> argument) onto which to restore the volume. Provide the
+partition's complete name with preceding slash (for example, F</vicepa>)
+or use one of the three acceptable abbreviated forms. For details, see
+L<vos(1)>.
+
+=item B<-name> <I<name of volume>>
+
+Specifies the name under which to restore the volume. It can be up to 22
+characters long, but cannot end with a C<.readonly> or C<.backup>
+extension. If the volume already exists, it is overwritten subject to the
+value of the B<-overwrite> argument.
+
+=item B<-file> <I<dump file>>
+
+Names the dump file to restore. Incomplete pathnames are interpreted
+relative to the current working directory. Omit this argument to provide
+the dump file via the standard input stream.
+
+=item B<-id> <I<volume ID>>
+
+Specifies the volume ID number to assign to the restored volume.
+
+=item B<-overwrite> (a | f | i)
+
+Specifies which type of dump file is being restored when overwriting an
+existing volume. Provide one of the following values:
+
+=over 4
+
+=item *
+
+C<a> to terminate the restore operation.
+
+=item *
+
+C<f> if restoring a full dump file.
+
+=item *
+
+C<i> if restoring an incremental dump file. This value is not acceptable
+if the B<-server> and B<-partition> arguments do not indicate the volume's
+current site.
+
+=back
+
+This argument is mandatory if the B<-file> argument is not provided.
+
+=item B<-offline>
+
+Leaves the new volume flagged as off-line in the volume database.
+
+=item B<-readonly>
+
+Flags the new volume as read-only in the volume database.
+
+=item B<-creation> <I<dump | keep | new>>
+
+Set the creation date of the new volume to the timestamp from the
+dumped volume (dump), from the target volume, if there is one (keep),
+or generate a new one using the current time (new).
+
+=item B<-lastupdate> <I<dump | keep | new>>
+
+Set the last updated date of the new volume to the timestamp from the
+dumped volume (dump), from the target volume, if there is one (keep),
+or generate a new one using the current time (new).
+
+=item B<-nodelete>
+
+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.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following command restores the contents of the dump file
+F</afs/example.com/common/dumps/terry.dump> to the F</vicepc> partition on the
+file server machine C<fs3.example.com>. The restored volume is named
+C<user.terry>.
+
+ % cd /afs/example.com/common/dumps
+ % vos restore -file terry.dump -server fs3.example.com -partition c \
+ -name 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<restorevol(1)>,
+L<vos(1)>,
+L<vos_dump(1)>,
+L<vos_examine(1)>,
+L<vos_listvol(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.
+++ /dev/null
-=head1 NAME
-
-vos_setaddrs - Set new addresses for a file server's entry in the VLDB
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos setaddrs> S<<< B<-uuid> <I<UUID of server>> >>>
- S<<< B<-host> <I<IP address>>+ >>>
- 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 seta> S<<< B<-u> <I<UUID of server>> >>>
- S<<< B<-ho> <I<IP address>>+ >>>
- 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 setaddrs> command sets the IP addresses for a server entry in
-the Volume Location Database (VLDB). Specify one or several IP addresses.
-All existing addresses in the VLDB server entry are replaced with the new
-addresses given on the command line.
-
-To find the UUID for a server entry, use the C<vos listaddrs -printuuid>
-command to display all VLDB server entries with their UUIDs.
-
-=head1 CAUTIONS
-
-Normally, the best way to change the registered addresses for a server
-entry is to restart the File Server process after changing the network
-configuration for that server and possibly the F<NetInfo> and
-F<NetRestrict> files for that server. See L<NetInfo(5)> and
-L<NetRestrict(5)> for more information about configuring the File Server
-to register the correct set of addresses. This command can be used to
-change the registered addresses without restarting the File Server, but
-the next time the File Server is restarted, it will register all of its
-known addresses again. You should therefore always ensure that the File
-Server configuration is correct for whenever it is next restarted before
-using this command.
-
-Setting the wrong addresses will make the volumes on that file server
-unreachable from AFS clients.
-
-This command was introduced in OpenAFS 1.5.74, but can be used with any
-version of the Volume Location Server.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-uuid> <I<UUID of server>>
-
-The unique ID as provided by the C<vos listaddrs -printuuid> command.
-
-=item B<-host> <I<IP address>>+
-
-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.
-
-=back
-
-=head1 EXAMPLES
-
-The following command sets addresses C<192.12.107.214> and C<10.47.11.17>
-for the UUID 008f157e-bad0-157c-0ffee-357c4d1faa77
-
- % vos setaddrs -uuid 008f157e-bad0-157c-0ffee-357c4d1faa77 \
- -host 192.12.107.214 -host 10.47.11.17 -verbose
- vos: Changed UUID with addresses:
- UUID: 008f157e-bad0-157c-0ffee-357c4d1faa77
- 192.12.107.214
- 10.47.11.17
-
-=head1 PRIVILEGE REQUIRED
-
-Issuer must be listed in the F</usr/afs/etc/UserList> file on each
-database server machine.
-
-=head1 SEE ALSO
-
-L<CellServDB(5)>,
-L<NetInfo(5)>,
-L<NetRestrict(5)>,
-L<UserList(5)>,
-L<sysid(5)>,
-L<fileserver(8)>,
-L<vos(1)>,
-L<vos_listaddrs(1)>
-
-=head1 COPYRIGHT
-
-KTH 2010. All Rights Reserved.
-
-This documentation is covered by the IBM Public License Version 1.0.
--- /dev/null
+=head1 NAME
+
+vos_setaddrs - Set new addresses for a file server's entry in the VLDB
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos setaddrs> S<<< B<-uuid> <I<UUID of server>> >>>
+ S<<< B<-host> <I<IP address>>+ >>>
+ 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 seta> S<<< B<-u> <I<UUID of server>> >>>
+ S<<< B<-ho> <I<IP address>>+ >>>
+ 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 setaddrs> command sets the IP addresses for a server entry in
+the Volume Location Database (VLDB). Specify one or several IP addresses.
+All existing addresses in the VLDB server entry are replaced with the new
+addresses given on the command line.
+
+To find the UUID for a server entry, use the C<vos listaddrs -printuuid>
+command to display all VLDB server entries with their UUIDs.
+
+=head1 CAUTIONS
+
+Normally, the best way to change the registered addresses for a server
+entry is to restart the File Server process after changing the network
+configuration for that server and possibly the F<NetInfo> and
+F<NetRestrict> files for that server. See L<NetInfo(5)> and
+L<NetRestrict(5)> for more information about configuring the File Server
+to register the correct set of addresses. This command can be used to
+change the registered addresses without restarting the File Server, but
+the next time the File Server is restarted, it will register all of its
+known addresses again. You should therefore always ensure that the File
+Server configuration is correct for whenever it is next restarted before
+using this command.
+
+Setting the wrong addresses will make the volumes on that file server
+unreachable from AFS clients.
+
+This command was introduced in OpenAFS 1.5.74, but can be used with any
+version of the Volume Location Server.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-uuid> <I<UUID of server>>
+
+The unique ID as provided by the C<vos listaddrs -printuuid> command.
+
+=item B<-host> <I<IP address>>+
+
+The new list of IP addresses for the File Server.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following command sets addresses C<192.12.107.214> and C<10.47.11.17>
+for the UUID 008f157e-bad0-157c-0ffee-357c4d1faa77
+
+ % vos setaddrs -uuid 008f157e-bad0-157c-0ffee-357c4d1faa77 \
+ -host 192.12.107.214 -host 10.47.11.17 -verbose
+ vos: Changed UUID with addresses:
+ UUID: 008f157e-bad0-157c-0ffee-357c4d1faa77
+ 192.12.107.214
+ 10.47.11.17
+
+=head1 PRIVILEGE REQUIRED
+
+Issuer must be listed in the F</usr/afs/etc/UserList> file on each
+database server machine.
+
+=head1 SEE ALSO
+
+L<CellServDB(5)>,
+L<NetInfo(5)>,
+L<NetRestrict(5)>,
+L<UserList(5)>,
+L<sysid(5)>,
+L<fileserver(8)>,
+L<vos(1)>,
+L<vos_listaddrs(1)>
+
+=head1 COPYRIGHT
+
+KTH 2010. All Rights Reserved.
+
+This documentation is covered by the IBM Public License Version 1.0.
+++ /dev/null
-=head1 NAME
-
-vos_setfields - Sets the quota or clear the access counter on a volume.
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos setfields> S<<< B<-id> <I<volume name or ID>> >>>
- S<<< B<-maxquota> <I<quota (KB)>> >>>
- [B<-clearuse>] [B<-clearVolUpCounter>]
- 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 se> S<<< B<-id> <I<volume name or ID>> >>>
- S<<< B<-m> <I<quota (KB)>> >>> [B<-cl>]
- S<<< [B<-ce> <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 setfields> command can set the quota on a volume, and it can
-clear the access counter on a volume. This command differs from
-B<fs setquota> because only the volume name is needed to set the quota,
-whereas the path to the volume is needed with B<fs setquota>.
-
-If the B<-maxquota> and B<-clearuse> flags are missing, then no action is
-taken.
-
-=head1 CAUTIONS
-
-This command is not effective on read-only or backup volumes.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-id> <I<volume name or id>>
-
-Identifies the volume on which to operate, either by its complete name or
-volume ID number.
-
-=item B<-maxquota> <I<quota>>
-
-Sets the maximum amount of file server disk space the volume can occupy.
-The quota should be a positive integer followed by an optional suffix:
-C<K> for kibibytes (1024 bytes, the default), C<M> for mebibytes (1024
-kibibytes), C<G> for gibibytes (1024 mebibytes), and C<T> for tebibytes
-(1024 gibibytes). A value of C<0> sets an unlimited quota, but the size
-of the disk partition that houses the volume places an absolute limit on
-the volume's size.
-
-=item B<-clearuse>
-
-Clears the access counter on a volume, which is shown as C<X accesses in
-the past day (i.e., vnode references)> in the B<vos examine> output.
-
-=item B<-clearVolUpCounter>
-
-Clears the modification counter on a volume. The modification counter
-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.
-
-=back
-
-=head1 OUTPUT
-
-This command produces no output other than error messages.
-
-=head1 EXAMPLES
-
-To set a 123KB quota on the root.cell volume, the following command may be
-used:
-
- % vos setfields -id root.cell -maxquota 123
-
-To clear the access counter on the root.cell volume, use the following
-command:
-
- % vos setfields -id root.cell -clearuse
-
-The above commands may be combined as follows:
-
- % vos setfields -id root.cell -maxquota 123 -clearuse
-
-=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<fs_setquota(1)>,
-L<vos(1)>,
-L<vos_examine(1)>
-
-=head1 COPYRIGHT
-
-Copyright 2009 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.
--- /dev/null
+=head1 NAME
+
+vos_setfields - Sets the quota or clear the access counter on a volume.
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos setfields> S<<< B<-id> <I<volume name or ID>> >>>
+ S<<< B<-maxquota> <I<quota (KB)>> >>>
+ [B<-clearuse>] [B<-clearVolUpCounter>]
+ 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 se> S<<< B<-id> <I<volume name or ID>> >>>
+ S<<< B<-m> <I<quota (KB)>> >>> [B<-cl>]
+ S<<< [B<-ce> <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 setfields> command can set the quota on a volume, and it can
+clear the access counter on a volume. This command differs from
+B<fs setquota> because only the volume name is needed to set the quota,
+whereas the path to the volume is needed with B<fs setquota>.
+
+If the B<-maxquota> and B<-clearuse> flags are missing, then no action is
+taken.
+
+=head1 CAUTIONS
+
+This command is not effective on read-only or backup volumes.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-id> <I<volume name or id>>
+
+Identifies the volume on which to operate, either by its complete name or
+volume ID number.
+
+=item B<-maxquota> <I<quota>>
+
+Sets the maximum amount of file server disk space the volume can occupy.
+The quota should be a positive integer followed by an optional suffix:
+C<K> for kibibytes (1024 bytes, the default), C<M> for mebibytes (1024
+kibibytes), C<G> for gibibytes (1024 mebibytes), and C<T> for tebibytes
+(1024 gibibytes). A value of C<0> sets an unlimited quota, but the size
+of the disk partition that houses the volume places an absolute limit on
+the volume's size.
+
+=item B<-clearuse>
+
+Clears the access counter on a volume, which is shown as C<X accesses in
+the past day (i.e., vnode references)> in the B<vos examine> output.
+
+=item B<-clearVolUpCounter>
+
+Clears the modification counter on a volume. The modification counter
+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.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 OUTPUT
+
+This command produces no output other than error messages.
+
+=head1 EXAMPLES
+
+To set a 123KB quota on the root.cell volume, the following command may be
+used:
+
+ % vos setfields -id root.cell -maxquota 123
+
+To clear the access counter on the root.cell volume, use the following
+command:
+
+ % vos setfields -id root.cell -clearuse
+
+The above commands may be combined as follows:
+
+ % vos setfields -id root.cell -maxquota 123 -clearuse
+
+=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<fs_setquota(1)>,
+L<vos(1)>,
+L<vos_examine(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2009 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.
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
+++ /dev/null
-=head1 NAME
-
-vos_size - Computes the size of a volume dump
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos size> S<<< [B<-id>] <I<volume name or id>> >>>
- S<<< [B<-partition> <I<partition name>>] >>>
- S<<< [B<-server> <I<machine name>>] >>>
- [B<-dump>] S<<< [B<-time> <I<dump from time>>] >>>
- 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 si> S<<< [B<-i>] <I<volume name or id>> >>>
- S<<< [B<-p> <I<partition name>>] >>>
- S<<< [B<-s> <I<machine name>>] >>>
- [B<-d>] S<<< [B<-t> <I<dump from time>>] >>>
- S<<< [B<-c> <I<cell name>>] >>>
- [B<-no>] [B<-l>]
- [B<-v>] [B<-e>] [B<-nor>]
- S<<< [B<-co> <I<config directory>>] >>>
- [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos size> command shows the size of a volume's dump for backup
-purposes. The size of the dump may differ from the volume size as reported
-by B<vos examine> or B<fs listquota>. The size is shown in bytes.
-
-This command is intended for use with backup systems that want to size
-volume dumps before performing them (to optimize use of tape resources,
-for example).
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-id> <I<volume name or id>>
-
-Specifies either the complete name or volume ID number of the read/write,
-read-only, or backup volume to size.
-
-=item B<-partition> <I<partition name>>
-
-Specifies the partition on which the volume resides. Provide the
-B<-server> argument along with this one.
-
-=item B<-server> <I<machine name>>
-
-Specifies the file server machine on which the volume resides. Provide
-the B<-partition> argument along with this one.
-
-=item B<-dump>
-
-Show the size of the volume dump for the specified volume. Currently, this
-flag should always be given for B<vos size> to give useful information.
-It is present to allow this command to provide other size estimates in the
-future.
-
-=item B<-time> <I<dump from time>>
-
-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.
-
-=back
-
-=head1 OUTPUT
-
-When run without B<-verbose>, the output will be:
-
- Volume: <volume>
- dump_size: <size>
-
-where <volume> is the name of the volume and <size> is the size of the
-dump in bytes. With B<-verbose>, additional status messages will be
-printed between those two lines.
-
-=head1 EXAMPLES
-
-Sizing a single user volume:
-
- % vos size user.thoron -dump
- Volume: user.thoron
- dump_size: 36430
-
-or, more verbosely:
-
- % vos size user.thoron -dump -verbose
- Volume: user.thoron
- Starting transaction on volume 2003434023... done
- Getting size of volume on volume 2003434023... done
- Ending transaction on volume 2003434023... done
- dump_size: 36430
-
-Sizing an incremental dump for the same volume:
-
- % vos size -id user.thoron -time '05/04/2007 00:00:00' -dump
- Volume: user.thoron
- dump_size: 21095
-
-=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 or the machine on which the
-volume is located if B<-server> was not given. 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<fs_listquota(1)>,
-L<vos_dump(1)>,
-L<vos_examine(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.
--- /dev/null
+=head1 NAME
+
+vos_size - Computes the size of a volume dump
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos size> S<<< [B<-id>] <I<volume name or id>> >>>
+ S<<< [B<-partition> <I<partition name>>] >>>
+ S<<< [B<-server> <I<machine name>>] >>>
+ [B<-dump>] S<<< [B<-time> <I<dump from time>>] >>>
+ 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 si> S<<< [B<-i>] <I<volume name or id>> >>>
+ S<<< [B<-p> <I<partition name>>] >>>
+ S<<< [B<-s> <I<machine name>>] >>>
+ [B<-d>] S<<< [B<-t> <I<dump from time>>] >>>
+ S<<< [B<-c> <I<cell name>>] >>>
+ [B<-no>] [B<-l>]
+ [B<-v>] [B<-e>] [B<-nor>]
+ S<<< [B<-co> <I<config directory>>] >>>
+ [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos size> command shows the size of a volume's dump for backup
+purposes. The size of the dump may differ from the volume size as reported
+by B<vos examine> or B<fs listquota>. The size is shown in bytes.
+
+This command is intended for use with backup systems that want to size
+volume dumps before performing them (to optimize use of tape resources,
+for example).
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-id> <I<volume name or id>>
+
+Specifies either the complete name or volume ID number of the read/write,
+read-only, or backup volume to size.
+
+=item B<-partition> <I<partition name>>
+
+Specifies the partition on which the volume resides. Provide the
+B<-server> argument along with this one.
+
+=item B<-server> <I<machine name>>
+
+Specifies the file server machine on which the volume resides. Provide
+the B<-partition> argument along with this one.
+
+=item B<-dump>
+
+Show the size of the volume dump for the specified volume. Currently, this
+flag should always be given for B<vos size> to give useful information.
+It is present to allow this command to provide other size estimates in the
+future.
+
+=item B<-time> <I<dump from time>>
+
+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.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 OUTPUT
+
+When run without B<-verbose>, the output will be:
+
+ Volume: <volume>
+ dump_size: <size>
+
+where <volume> is the name of the volume and <size> is the size of the
+dump in bytes. With B<-verbose>, additional status messages will be
+printed between those two lines.
+
+=head1 EXAMPLES
+
+Sizing a single user volume:
+
+ % vos size user.thoron -dump
+ Volume: user.thoron
+ dump_size: 36430
+
+or, more verbosely:
+
+ % vos size user.thoron -dump -verbose
+ Volume: user.thoron
+ Starting transaction on volume 2003434023... done
+ Getting size of volume on volume 2003434023... done
+ Ending transaction on volume 2003434023... done
+ dump_size: 36430
+
+Sizing an incremental dump for the same volume:
+
+ % vos size -id user.thoron -time '05/04/2007 00:00:00' -dump
+ Volume: user.thoron
+ dump_size: 21095
+
+=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 or the machine on which the
+volume is located if B<-server> was not given. 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<fs_listquota(1)>,
+L<vos_dump(1)>,
+L<vos_examine(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.
+++ /dev/null
-=head1 NAME
-
-vos_status - Reports a Volume Server's status
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos status> 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 st> 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 status> command reports on what the Volume Server on a certain
-file server machine is doing at the moment the command is issued. If there
-is no activity, the following message appears:
-
- No active transactions on <machine_name>
-
-This command is useful mainly if there is concern that the Volume Server
-is not performing requested actions.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-server> <I<server name>>
-
-Identifies the file server machine running the Volume Server for which to
-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.
-
-=back
-
-=head1 OUTPUT
-
-There are two possible types of output.
-
-The following message indicates that the Volume Server is not currently
-performing any actions.
-
- No active transactions on I<machine name>
-
-The other possible output is a set of information which is probably more
-useful to programmers than to system administrators. A full understanding
-of all the fields requires familiarity with the code for the Volume
-Server, as many of the fields report ID numbers and flag values that the
-Volume Server sets for internal use.
-
-Among the fields of possible interest to an administrator are:
-
-=over 4
-
-=item *
-
-C<created> on the first line, which indicates the time at which this
-transaction started
-
-=item *
-
-In OpenAFS 1.5.75 and later, C<lastActiveTime> on the second line, which
-indicates the last time an RPC interacted with this transaction
-
-=item *
-
-C<attachFlags> on the third line, where a value of C<offline> indicates
-that the volume is not available for other read or write operations during
-this transaction
-
-=item *
-
-C<volume> on the fourth line, which specifies the affected volume's ID
-number
-
-=item *
-
-C<partition> on the fourth line, which indicates where the affected volume
-resides (at the beginning of the transaction if this is a move)
-
-=item *
-
-C<procedure> on the fourth line, which indicates the internal subprocedure
-being executed
-
-=back
-
-A fifth line can appear during certain transactions, and includes the
-following fields:
-
-=over 4
-
-=item *
-
-C<packetRead> tracks whether information is being read into the
-volume. Its absolute value is not informative, but the way it changes
-shows whether the B<vos restore> command is executing properly. As the
-B<vos status> command is issued repeatedly during a restore, C<readNext>
-increases monotonically to indicate that information is being read into
-the volume.
-
-=item *
-
-C<packetSend> tracks whether information is being sent out of the
-volume. Its absolute value is not informative, but the way it changes
-shows whether the B<vos dump> command is executing properly. As the B<vos
-status> command is issued repeatedly during a dump, C<transmitNext>
-increases monotonically to indicate that information is being transferred
-from the volume into the dump file.
-
-=back
-
-The C<lastReceiveTime> and C<lastSendTime> are for internal use.
-
-=head1 EXAMPLES
-
-The following example illustrates the kind of output that sometimes
-appears when the Volume Server on C<fs1.example.com> is executing a dump at
-the time this command is issued.
-
- % vos status fs1.example.com
- --------------------------------------------
- transaction: 575 created: Tue Jan 2 8:34:56 1990
- attachFlags: offline
- volume: 536871080 partition: /vicepb procedure: Dump
- packetRead: 2 lastReceiveTime: 113313 packetSend: 24588
- lastSendTime: 113317
- --------------------------------------------
-
-=head1 PRIVILEGE REQUIRED
-
-None
-
-=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.
--- /dev/null
+=head1 NAME
+
+vos_status - Reports a Volume Server's status
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos status> 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 st> 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 status> command reports on what the Volume Server on a certain
+file server machine is doing at the moment the command is issued. If there
+is no activity, the following message appears:
+
+ No active transactions on <machine_name>
+
+This command is useful mainly if there is concern that the Volume Server
+is not performing requested actions.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-server> <I<server name>>
+
+Identifies the file server machine running the Volume Server for which to
+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)>.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 OUTPUT
+
+There are two possible types of output.
+
+The following message indicates that the Volume Server is not currently
+performing any actions.
+
+ No active transactions on I<machine name>
+
+The other possible output is a set of information which is probably more
+useful to programmers than to system administrators. A full understanding
+of all the fields requires familiarity with the code for the Volume
+Server, as many of the fields report ID numbers and flag values that the
+Volume Server sets for internal use.
+
+Among the fields of possible interest to an administrator are:
+
+=over 4
+
+=item *
+
+C<created> on the first line, which indicates the time at which this
+transaction started
+
+=item *
+
+In OpenAFS 1.5.75 and later, C<lastActiveTime> on the second line, which
+indicates the last time an RPC interacted with this transaction
+
+=item *
+
+C<attachFlags> on the third line, where a value of C<offline> indicates
+that the volume is not available for other read or write operations during
+this transaction
+
+=item *
+
+C<volume> on the fourth line, which specifies the affected volume's ID
+number
+
+=item *
+
+C<partition> on the fourth line, which indicates where the affected volume
+resides (at the beginning of the transaction if this is a move)
+
+=item *
+
+C<procedure> on the fourth line, which indicates the internal subprocedure
+being executed
+
+=back
+
+A fifth line can appear during certain transactions, and includes the
+following fields:
+
+=over 4
+
+=item *
+
+C<packetRead> tracks whether information is being read into the
+volume. Its absolute value is not informative, but the way it changes
+shows whether the B<vos restore> command is executing properly. As the
+B<vos status> command is issued repeatedly during a restore, C<readNext>
+increases monotonically to indicate that information is being read into
+the volume.
+
+=item *
+
+C<packetSend> tracks whether information is being sent out of the
+volume. Its absolute value is not informative, but the way it changes
+shows whether the B<vos dump> command is executing properly. As the B<vos
+status> command is issued repeatedly during a dump, C<transmitNext>
+increases monotonically to indicate that information is being transferred
+from the volume into the dump file.
+
+=back
+
+The C<lastReceiveTime> and C<lastSendTime> are for internal use.
+
+=head1 EXAMPLES
+
+The following example illustrates the kind of output that sometimes
+appears when the Volume Server on C<fs1.example.com> is executing a dump at
+the time this command is issued.
+
+ % vos status fs1.example.com
+ --------------------------------------------
+ transaction: 575 created: Tue Jan 2 8:34:56 1990
+ attachFlags: offline
+ volume: 536871080 partition: /vicepb procedure: Dump
+ packetRead: 2 lastReceiveTime: 113313 packetSend: 24588
+ lastSendTime: 113317
+ --------------------------------------------
+
+=head1 PRIVILEGE REQUIRED
+
+None
+
+=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.
+++ /dev/null
-=head1 NAME
-
-vos_syncserv - Verifies VLDB entries that mention a specified site
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos syncserv> S<<< B<-server> <I<machine name>> >>>
- S<<< [B<-partition> <I<partition name>>] >>>
- S<<< [B<-cell> <I<cell name>>] >>>
- [B<-dryrun>]
- [B<-noauth>] [B<-localauth>]
- [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
- S<<< [B<-config> <I<config directory>>] >>>
- [B<-help>]
-
-B<vos syncs> S<<< B<-s> <I<machine name>> >>>
- S<<< [B<-p> <I<partition name>>] >>>
- S<<< [B<-c> <I<cell name>>] >>> [B<-d>]
- [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 syncserv> command verifies that each volume mentioned in a VLDB
-entry actually exists at the site indicated in the entry. It checks all
-VLDB entries that mention a read/write, read-only, or backup site either
-on any partition on the file server machine specified by the B<-server>
-argument, or on the one partition specified by the B<-server> and
-B<-partition> arguments. Note that the command can end up inspecting sites
-other than those specified by the B<-server> and B<-partition> arguments,
-if there are versions of the volume at sites other than the one specified.
-
-The command alters any incorrect information in the VLDB, unless there is
-an irreconcilable conflict with other VLDB entries. In that case, it
-writes a message to the standard error stream instead. The command never
-removes volumes from file server machines.
-
-To achieve complete VLDB consistency, first run the B<vos syncvldb>
-command on all file server machines in the cell, then run this command on
-all file server machines in the cell.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-server> <I<server name>>
-
-Identifies the file server machine mentioned in each VLDB entry to
-check. 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 mentioned in each VLDB entry to check. 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<-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.
-
-=back
-
-=head1 EXAMPLES
-
-The following example verifies the VLDB entries in which a site definition
-mentions the file server machine C<fs3.example.com>.
-
- % vos syncserv -server fs3.example.com
-
-=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_syncvldb(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.
--- /dev/null
+=head1 NAME
+
+vos_syncserv - Verifies VLDB entries that mention a specified site
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos syncserv> S<<< B<-server> <I<machine name>> >>>
+ S<<< [B<-partition> <I<partition name>>] >>>
+ S<<< [B<-cell> <I<cell name>>] >>>
+ [B<-dryrun>]
+ [B<-noauth>] [B<-localauth>]
+ [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
+ S<<< [B<-config> <I<config directory>>] >>>
+ [B<-help>]
+
+B<vos syncs> S<<< B<-s> <I<machine name>> >>>
+ S<<< [B<-p> <I<partition name>>] >>>
+ S<<< [B<-c> <I<cell name>>] >>> [B<-d>]
+ [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 syncserv> command verifies that each volume mentioned in a VLDB
+entry actually exists at the site indicated in the entry. It checks all
+VLDB entries that mention a read/write, read-only, or backup site either
+on any partition on the file server machine specified by the B<-server>
+argument, or on the one partition specified by the B<-server> and
+B<-partition> arguments. Note that the command can end up inspecting sites
+other than those specified by the B<-server> and B<-partition> arguments,
+if there are versions of the volume at sites other than the one specified.
+
+The command alters any incorrect information in the VLDB, unless there is
+an irreconcilable conflict with other VLDB entries. In that case, it
+writes a message to the standard error stream instead. The command never
+removes volumes from file server machines.
+
+To achieve complete VLDB consistency, first run the B<vos syncvldb>
+command on all file server machines in the cell, then run this command on
+all file server machines in the cell.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-server> <I<server name>>
+
+Identifies the file server machine mentioned in each VLDB entry to
+check. 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 mentioned in each VLDB entry to check. 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<-dryrun>
+
+Show the actions which would be taken, but do not make changes.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following example verifies the VLDB entries in which a site definition
+mentions the file server machine C<fs3.example.com>.
+
+ % vos syncserv -server fs3.example.com
+
+=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_syncvldb(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.
+++ /dev/null
-=head1 NAME
-
-vos_syncvldb - Verifies VLDB entries for volumes residing at specified site
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos syncvldb> S<<< [B<-server> <I<machine name>>] >>>
- S<<< [B<-partition> <I<partition name>>] >>>
- S<<< [B<-volume> <I<volume name or ID>>] >>>
- [B<-dryrun>] 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 syncv> S<<< [B<-s> <I<machine name>>] >>>
- S<<< [B<-p> <I<partition name>>] >>>
- S<<< [B<-vo> <I<volume name or ID>>] >>>
- [B<-d>] S<<< [B<-c> <I<cell name>>] >>>
- [B<-noa>] [B<-l>] [B<-ve>] [B<-e>] [B<-nor>]
- S<<< [B<-co> <I<config directory>>] >>>
- [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos syncvldb> command verifies that the status of the volumes housed
-either on all partitions on the file server machine specified by the
-B<-server> argument, or on the single partition specified by the
-B<-server> and B<-partition> arguments, is recorded correctly in the
-VLDB. If the B<-volume> argument is included to indicate a single volume,
-the command compares only its status on the file server machine with its
-VLDB entry.
-
-If the B<-volume> argument is not included, the command interpreter
-obtains from the Volume Server a list of the volumes that reside on each
-partition, then changes information in the VLDB as necessary to reflect
-their state on the partition. For example, it creates or updates a VLDB
-entry when it finds a volume for which the VLDB entry is missing or
-incomplete. However, if there is already a VLDB entry that defines a
-different location for the volume, or there are irreconcilable conflicts
-with other VLDB entries, it instead writes a message about the conflict to
-the standard error stream. The command never removes volumes from the file
-server machine.
-
-To achieve complete VLDB consistency, run this command on all file server
-machines in the cell, and then run the B<vos syncserv> command on all file
-server machines in the cell.
-
-Using the B<-volume> argument basically combines the effects of this
-command with those of the B<vos syncserv> command, for a single
-volume. The command not only verifies that the VLDB entry is correct for
-the specified volume type (read/write, backup, or read-only), but also
-checks that any related volume types mentioned in the VLDB entry actually
-exist at the site listed in the entry. It is not necessary to provide the
-B<-server> argument (and optionally, B<-partition> argument); if one or
-both is provided, the results are reliable only if they specify the actual
-location of the volume indicated by the B<-volume> argument.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-server> <I<server name>>
-
-Identifies the file server machine housing the volumes for which to verify
-VLDB entries. 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 housing the volumes for which to verify VLDB
-entries. Provide the B<-server> argument along with this one. 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<-volume> <I<volume name or ID>>
-
-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.
-
-=back
-
-=head1 EXAMPLES
-
-The following example command verifies the VLDB entry for each volume
-stored on the file server machine C<fs4.example.com>.
-
- % vos syncvldb fs4.example.com
-
-=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_syncserv(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.
--- /dev/null
+=head1 NAME
+
+vos_syncvldb - Verifies VLDB entries for volumes residing at specified site
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos syncvldb> S<<< [B<-server> <I<machine name>>] >>>
+ S<<< [B<-partition> <I<partition name>>] >>>
+ S<<< [B<-volume> <I<volume name or ID>>] >>>
+ [B<-dryrun>] 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 syncv> S<<< [B<-s> <I<machine name>>] >>>
+ S<<< [B<-p> <I<partition name>>] >>>
+ S<<< [B<-vo> <I<volume name or ID>>] >>>
+ [B<-d>] S<<< [B<-c> <I<cell name>>] >>>
+ [B<-noa>] [B<-l>] [B<-ve>] [B<-e>] [B<-nor>]
+ S<<< [B<-co> <I<config directory>>] >>>
+ [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos syncvldb> command verifies that the status of the volumes housed
+either on all partitions on the file server machine specified by the
+B<-server> argument, or on the single partition specified by the
+B<-server> and B<-partition> arguments, is recorded correctly in the
+VLDB. If the B<-volume> argument is included to indicate a single volume,
+the command compares only its status on the file server machine with its
+VLDB entry.
+
+If the B<-volume> argument is not included, the command interpreter
+obtains from the Volume Server a list of the volumes that reside on each
+partition, then changes information in the VLDB as necessary to reflect
+their state on the partition. For example, it creates or updates a VLDB
+entry when it finds a volume for which the VLDB entry is missing or
+incomplete. However, if there is already a VLDB entry that defines a
+different location for the volume, or there are irreconcilable conflicts
+with other VLDB entries, it instead writes a message about the conflict to
+the standard error stream. The command never removes volumes from the file
+server machine.
+
+To achieve complete VLDB consistency, run this command on all file server
+machines in the cell, and then run the B<vos syncserv> command on all file
+server machines in the cell.
+
+Using the B<-volume> argument basically combines the effects of this
+command with those of the B<vos syncserv> command, for a single
+volume. The command not only verifies that the VLDB entry is correct for
+the specified volume type (read/write, backup, or read-only), but also
+checks that any related volume types mentioned in the VLDB entry actually
+exist at the site listed in the entry. It is not necessary to provide the
+B<-server> argument (and optionally, B<-partition> argument); if one or
+both is provided, the results are reliable only if they specify the actual
+location of the volume indicated by the B<-volume> argument.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-server> <I<server name>>
+
+Identifies the file server machine housing the volumes for which to verify
+VLDB entries. 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 housing the volumes for which to verify VLDB
+entries. Provide the B<-server> argument along with this one. 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<-volume> <I<volume name or ID>>
+
+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<-dryrun>
+
+Show the actions which would be taken, but do not make changes.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following example command verifies the VLDB entry for each volume
+stored on the file server machine C<fs4.example.com>.
+
+ % vos syncvldb fs4.example.com
+
+=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_syncserv(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.
+++ /dev/null
-=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.
--- /dev/null
+=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.
+++ /dev/null
-=head1 NAME
-
-vos_unlockvldb - Unlocks several locked VLDB entries
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos unlockvldb> S<<< [B<-server> <I<machine name>>] >>>
- S<<< [B<-partition> <I<partition 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 unlockv> S<<< [B<-s> <I<machine name>>] >>>
- S<<< [B<-p> <I<partition 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 unlockvldb> command releases the lock on the Volume Location
-Database (VLDB) entries indicated by the combination of arguments
-provided:
-
-=over 4
-
-=item *
-
-To unlock all entries in the VLDB, provide no arguments.
-
-=item *
-
-To unlock all entries that mention a file server machine in a site
-definition, provide its name with the B<-server> argument.
-
-=item *
-
-To unlock all entries that mention a partition on any file server machine
-in a site definition, provide the partition name with the B<-partition>
-argument.
-
-=item *
-
-To unlock all entries that mention a specific site, provide both the
-B<-server> and B<-partition> arguments.
-
-=back
-
-To unlock a single volume, use the B<vos unlock> command instead.
-
-=head1 CAUTIONS
-
-Do not use this command under normal circumstances.
-
-It is useful if VLDB entries for volumes at a certain site are 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 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<-server> <I<server name>>
-
-Identifies the file server machine for which to unlock VLDB
-entries. 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 specified by the
-B<-server> argument) for which to unlock VLDB entries. 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<-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 unlocks all locked entries in the VLDB.
-
- % vos unlockvldb
-
-The following command unlocks all locked VLDB entries that mention the
-F</vicepa> partition in a site definition.
-
- % vos unlockvldb -partition a
-
-The following command unlocks all locked VLDB entries that refer to
-volumes on the F</vicepc> partition of the file server machine
-C<fs3.example.com>.
-
- % vos unlockvldb -server fs3.example.com -partition c
-
-=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_unlock(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.
--- /dev/null
+=head1 NAME
+
+vos_unlockvldb - Unlocks several locked VLDB entries
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos unlockvldb> S<<< [B<-server> <I<machine name>>] >>>
+ S<<< [B<-partition> <I<partition 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 unlockv> S<<< [B<-s> <I<machine name>>] >>>
+ S<<< [B<-p> <I<partition 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 unlockvldb> command releases the lock on the Volume Location
+Database (VLDB) entries indicated by the combination of arguments
+provided:
+
+=over 4
+
+=item *
+
+To unlock all entries in the VLDB, provide no arguments.
+
+=item *
+
+To unlock all entries that mention a file server machine in a site
+definition, provide its name with the B<-server> argument.
+
+=item *
+
+To unlock all entries that mention a partition on any file server machine
+in a site definition, provide the partition name with the B<-partition>
+argument.
+
+=item *
+
+To unlock all entries that mention a specific site, provide both the
+B<-server> and B<-partition> arguments.
+
+=back
+
+To unlock a single volume, use the B<vos unlock> command instead.
+
+=head1 CAUTIONS
+
+Do not use this command under normal circumstances.
+
+It is useful if VLDB entries for volumes at a certain site are 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 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<-server> <I<server name>>
+
+Identifies the file server machine for which to unlock VLDB
+entries. 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 specified by the
+B<-server> argument) for which to unlock VLDB entries. 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)>.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following command unlocks all locked entries in the VLDB.
+
+ % vos unlockvldb
+
+The following command unlocks all locked VLDB entries that mention the
+F</vicepa> partition in a site definition.
+
+ % vos unlockvldb -partition a
+
+The following command unlocks all locked VLDB entries that refer to
+volumes on the F</vicepc> partition of the file server machine
+C<fs3.example.com>.
+
+ % vos unlockvldb -server fs3.example.com -partition c
+
+=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_unlock(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.
projects / packages / o / openafs.git / commitdiff