man-page-license-change-20071225
[openafs.git] / doc / man-pages / pod1 / vos_size.pod
1 =head1 NAME
2
3 vos_size - Computes the size of a volume dump
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos size> S<<< [B<-cell> <I<cell name>>] >>> [B<-dump>]
11     [B<-encrypt>] [B<-help>] [B<-id>] <I<volume name or id>>
12     [B<-localauth>] [B<-noauth>]
13     S<<< [B<-partition> <I<partition name>>] >>>
14     S<<< [B<-server> <I<machine name>>] >>>
15     S<<< [B<-time> <I<dump from time>>] >>> [B<-verbose>]
16
17 =for html
18 </div>
19
20 =head1 DESCRIPTION
21
22 The B<vos size> command shows the size of a volume's dump for backup
23 purposes. The size of the dump may differ from the volume size as reported
24 by B<vos examine> or B<fs listquota>. The size is shown in bytes.
25
26 This command is intended for use with backup systems that want to size
27 volume dumps before performing them (to optimize use of tape resources,
28 for example).
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-cell> <I<cell name>>
35
36 The cell in which the volume resides, if it's not in the current cell.
37
38 =item B<-dump>
39
40 Show the size of the volume dump for the specified volume. Currently, this
41 flag should always be given for B<vos size> to give useful information.
42 It is present to allow this command to provide other size estimates in the
43 future.
44
45 =item B<-encrypt>
46
47 Encrypt the command.
48
49 =item B<-help>
50
51 Prints the online help for this command. All other valid options are
52 ignored.
53
54 =item B<-id> <I<volume name or id>>
55
56 Specifies either the complete name or volume ID number of the read/write,
57 read-only, or backup volume to size.
58
59 =item B<-localauth>
60
61 Constructs a server ticket using a key from the local
62 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
63 to the Volume Server and Volume Location Server during mutual
64 authentication. Do not combine this flag with the B<-cell> argument or
65 B<-noauth> flag. For more details, see L<vos(1)>.
66
67 =item B<-noauth>
68
69 Assigns the unprivileged identity anonymous to the issuer. Do not combine
70 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
71
72 =item B<-partition> <I<partition name>>
73
74 Specifies the partition on which the volume resides. Provide the
75 B<-server> argument along with this one.
76
77 =item B<-server> <I<machine name>>
78
79 Specifies the file server machine on which the volume resides.  Provide
80 the B<-partition> argument along with this one.
81
82 =item B<-time> <I<dump from time>>
83
84 Specifies whether the dump is full or incremental. Omit this argument to
85 size a full dump. See L<vos_dump(1)> for the valid values for this
86 option.
87
88 =item B<-verbose>
89
90 Show more output about what's going on.
91
92 =back
93
94 =head1 OUTPUT
95
96 When run without B<-verbose>, the output will be:
97
98    Volume: <volume>
99    dump_size: <size>
100
101 where <volume> is the name of the volume and <size> is the size of the
102 dump in bytes. With B<-verbose>, additional status messages will be
103 printed between those two lines.
104
105 =head1 EXAMPLES
106
107 Sizing a single user volume:
108
109    % vos size user.thoron -dump
110    Volume: user.thoron
111    dump_size: 36430
112
113 or, more verbosely:
114
115    % vos size user.thoron -dump -verbose
116    Volume: user.thoron
117    Starting transaction on volume 2003434023... done
118    Getting size of volume on volume 2003434023... done
119    Ending transaction on volume 2003434023... done
120    dump_size: 36430
121
122 Sizing an incremental dump for the same volume:
123
124    % vos size -id user.thoron -time '05/04/2007 00:00:00' -dump 
125    Volume: user.thoron
126    dump_size: 21095
127
128 =head1 PRIVILEGE REQUIRED
129
130 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
131 machine specified with the B<-server> argument or the machine on which the
132 volume is located if B<-server> was not given.  If the B<-localauth> flag
133 is included, the issuer must instead be logged on to a server machine as
134 the local superuser C<root>.
135
136 =head1 SEE ALSO
137
138 L<fs_listquota(1)>,
139 L<vos_dump(1)>,
140 L<vos_examine(1)>
141
142 =head1 COPYRIGHT
143
144 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
145
146 This documentation is covered by the BSD License as written in the
147 doc/LICENSE file. This man page was written by Jason Edgecombe for
148 OpenAFS.