.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "VOS_SIZE 1" .TH VOS_SIZE 1 "2021-01-14" "OpenAFS" "AFS Command Reference" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" vos_size \- Computes the size of a volume dump .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBvos size\fR [\fB\-id\fR]\ <\fIvolume\ name\ or\ id\fR> [\fB\-partition\fR\ <\fIpartition\ name\fR>] [\fB\-server\fR\ <\fImachine\ name\fR>] [\fB\-dump\fR] [\fB\-time\fR\ <\fIdump\ from\ time\fR>] [\fB\-cell\fR\ <\fIcell\ name\fR>] [\fB\-noauth\fR] [\fB\-localauth\fR] [\fB\-verbose\fR] [\fB\-encrypt\fR] [\fB\-noresolve\fR] [\fB\-config\fR\ <\fIconfig\ directory\fR>] [\fB\-help\fR] .PP \&\fBvos si\fR [\fB\-i\fR]\ <\fIvolume\ name\ or\ id\fR> [\fB\-p\fR\ <\fIpartition\ name\fR>] [\fB\-s\fR\ <\fImachine\ name\fR>] [\fB\-d\fR] [\fB\-t\fR\ <\fIdump\ from\ time\fR>] [\fB\-c\fR\ <\fIcell\ name\fR>] [\fB\-no\fR] [\fB\-l\fR] [\fB\-v\fR] [\fB\-e\fR] [\fB\-nor\fR] [\fB\-co\fR\ <\fIconfig\ directory\fR>] [\fB\-h\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBvos size\fR 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 \fBvos examine\fR or \fBfs listquota\fR. The size is shown in bytes. .PP 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). .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-id\fR <\fIvolume name or id\fR>" 4 .IX Item "-id " Specifies either the complete name or volume \s-1ID\s0 number of the read/write, read-only, or backup volume to size. .IP "\fB\-partition\fR <\fIpartition name\fR>" 4 .IX Item "-partition " Specifies the partition on which the volume resides. Provide the \&\fB\-server\fR argument along with this one. .IP "\fB\-server\fR <\fImachine name\fR>" 4 .IX Item "-server " Specifies the file server machine on which the volume resides. Provide the \fB\-partition\fR argument along with this one. .IP "\fB\-dump\fR" 4 .IX Item "-dump" Show the size of the volume dump for the specified volume. Currently, this flag should always be given for \fBvos size\fR to give useful information. It is present to allow this command to provide other size estimates in the future. .IP "\fB\-time\fR <\fIdump from time\fR>" 4 .IX Item "-time " Specifies whether the dump is full or incremental. Omit this argument to size a full dump. See \fBvos_dump\fR\|(1) for the valid values for this option. .IP "\fB\-cell\fR <\fIcell name\fR>" 4 .IX Item "-cell " Names the cell in which to run the command. Do not combine this argument with the \fB\-localauth\fR flag. For more details, see \fBvos\fR\|(1). .IP "\fB\-noauth\fR" 4 .IX Item "-noauth" Assigns the unprivileged identity \f(CW\*(C`anonymous\*(C'\fR to the issuer. Do not combine this flag with the \fB\-localauth\fR flag. For more details, see \&\fBvos\fR\|(1). .IP "\fB\-localauth\fR" 4 .IX Item "-localauth" Constructs a server ticket using a key from the local \&\fI/etc/openafs/server/KeyFile\fR file. The \fBvos\fR command interpreter presents it to the Volume Server and Volume Location Server during mutual authentication. Do not combine this flag with the \fB\-cell\fR argument or \&\fB\-noauth\fR flag. For more details, see \fBvos\fR\|(1). .IP "\fB\-verbose\fR" 4 .IX Item "-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. .IP "\fB\-encrypt\fR" 4 .IX Item "-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. .IP "\fB\-noresolve\fR" 4 .IX Item "-noresolve" Shows all servers as \s-1IP\s0 addresses instead of the \s-1DNS\s0 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. .IP "\fB\-config\fR <\fIconfiguration directory\fR>" 4 .IX Item "-config " Set the location of the configuration directory to be used. This defaults to \&\fI/etc/openafs\fR, except if \fB\-localauth\fR is specified, in which case the default is \fI/etc/openafs/server\fR. This option allows the use of alternative configuration locations for testing purposes. .IP "\fB\-help\fR" 4 .IX Item "-help" Prints the online help for this command. All other valid options are ignored. .SH "OUTPUT" .IX Header "OUTPUT" When run without \fB\-verbose\fR, the output will be: .PP .Vb 2 \& Volume: \& dump_size: .Ve .PP where is the name of the volume and is the size of the dump in bytes. With \fB\-verbose\fR, additional status messages will be printed between those two lines. .SH "EXAMPLES" .IX Header "EXAMPLES" Sizing a single user volume: .PP .Vb 3 \& % vos size user.thoron \-dump \& Volume: user.thoron \& dump_size: 36430 .Ve .PP or, more verbosely: .PP .Vb 6 \& % 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 .Ve .PP Sizing an incremental dump for the same volume: .PP .Vb 3 \& % vos size \-id user.thoron \-time \*(Aq05/04/2007 00:00:00\*(Aq \-dump \& Volume: user.thoron \& dump_size: 21095 .Ve .SH "PRIVILEGE REQUIRED" .IX Header "PRIVILEGE REQUIRED" The issuer must be listed in the \fI/etc/openafs/server/UserList\fR file on the machine specified with the \fB\-server\fR argument or the machine on which the volume is located if \fB\-server\fR was not given. If the \fB\-localauth\fR flag is included, the issuer must instead be logged on to a server machine as the local superuser \f(CW\*(C`root\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBfs_listquota\fR\|(1), \&\fBvos_dump\fR\|(1), \&\fBvos_examine\fR\|(1) .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2007 Jason Edgecombe .PP This documentation is covered by the \s-1BSD\s0 License as written in the doc/LICENSE file. This man page was written by Jason Edgecombe for OpenAFS.