mirror of
https://git.openafs.org/openafs.git
synced 2025-01-18 23:10:58 +00:00
ade56fa2f9
Many manpages for "vos" subcommands were not using the "common" vos fragments, and instead were just repeating the information directly in their manpage. Make them all use the "common" vos fragment to avoid duplication. Change-Id: I62d84a1164b4ba46082e33a6d27fd24e3722014c Reviewed-on: http://gerrit.openafs.org/10398 Reviewed-by: Derrick Brashear <shadow@your-file-system.com> Tested-by: BuildBot <buildbot@rampaginggeek.com>
134 lines
3.6 KiB
Plaintext
134 lines
3.6 KiB
Plaintext
=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.
|