.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "VDFCP.PL 1"
.TH VDFCP.PL 1 "2014-12-18" "perl v5.16.3" "User Contributed Perl Documentation"
.\" 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"
vdfcp.pl \- Copy a vdf dataset, either partially or entirely
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBvdfcp.pl\fR [options] \fIsrcvdf\fR \fIdestination\fR
\&\fBvdfcp.pl\fR \-list \fIsrcvdf\fR
\&\fBvdfcp.pl\fR \-info \fIsrcvdf\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBvdfcp.pl\fR copies \fIsrcvdf\fR, or part of \fIsrcvdf\fR, to \fIdestination\fR. The first
form does this. The second form is used to obtain a list of the files that
would be copied if the first form were used on \fIsrcvdf\fR. The third form prints
a human-readable message detailing the available ranges of timesteps, variables
and refinement available in \fIsrcvdf\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\-list" 4
.IX Item "-list"
Tells vdfcp.pl to list the items it would copy, instead of actually copying them.
This list includes the .vdf metafile itself, and is delimited by newlines.
No destination is needed when \-info is given, as nothing will be copied.
.IP "\-info" 4
.IX Item "-info"
Tells vdfcp.pl to display available variables, timesteps and levels in a 
human-readable format. If given with arguments like ts0, ts1, numts, level, 
vars and nvars, the report will be limited to the selected ranges. This will 
also tell you if parts of your selection are not available in the dataset. 
No destination is needed when \-info is given, as nothing will be copied.
Overrides \-list.
.IP "\-vars <v1:v2:v3:...>" 4
.IX Item "-vars <v1:v2:v3:...>"
A colon-delimited list of names of variables. These variables will be included
in any listing or copying done by vdfcp.pl at runtime.
.IP "\-nvars <v1:v2:v3:...>" 4
.IX Item "-nvars <v1:v2:v3:...>"
A colon-delimited list of names of variables. These variables will \s-1NOT\s0 be 
included in any listing or copying done by vdfcp.pl at runtime. Overrides \-vars.
.IP "\-ts0 <#>" 4
.IX Item "-ts0 <#>"
The number of the first timestep to copy or scan from the source dataset.
This option has the highest priority of any timestep-related options.
.IP "\-ts1 <#>" 4
.IX Item "-ts1 <#>"
The number of the last timestep to copy or scan from the source dataset.
.IP "\-numts <#>" 4
.IX Item "-numts <#>"
The number of timesteps to copy or scan from the source dataset. This option
has the lowest priority of any timestep-related options.
.IP "\-level <#>" 4
.IX Item "-level <#>"
The highest level of refinement to scan or copy from the source dataset. All
levels below this will be copied as well.
.IP "\-f" 4
.IX Item "-f"
Tells vdfcp.pl to overwrite any existing dataset at the specified destination. If
vdfcp.pl is overwriting an existing dataset, it will print warnings.
.IP "\-v" 4
.IX Item "-v"
Prints information while copying, including a confirmation of the source and
destination .vdf metafiles, and the variables being copied.
.IP "\-help" 4
.IX Item "-help"
Print a usage statement and then exit.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
The command...
.PP
\&\f(CW\*(C`vdfcp.pl \-vars P:T \-level 2 \-ts0 10 \-numts 20 path/to/source.vdf path/to/data\*(C'\fR
.PP
\&...will copy source.vdf and its associated dataset to the path/to/data directory,
which must exist prior to the execution of the command. If instead of typing 
\&\*(L"path/to/data\*(R", the user had typed \*(L"path/to/data.vdf\*(R", data.vdf would become the
metafile for the new dataset, and data_data would be placed in the same directory.
Only the variables P and T will be copied, only levels 0, 1 and 2, and timesteps
10 through 29 will be copied to the new dataset.
.PP
This command...
.PP
\&\f(CW\*(C`tar \-cf foo.tar \`vdfcp.pl \-list \-ts1 50 \-numts 20 path/to/source.vdf\`\*(C'\fR
.PP
\&...will cause tar to archive all files required to represent timesteps 31 to 50 of
source.vdf's associated dataset in foo.tar. Note that when ts1 is used with numts,
the range of copied timesteps ends at ts1. However, if ts0 were also specified,
it would take priority and the range would begin at ts0. If only numts is given,
then the range will begin at the first timestep of the dataset.
.PP
This command...
.PP
\&\f(CW\*(C`vdfcp.pl \-info \-nvars bx:bz ts1 30 path/to/source.vdf\*(C'\fR
.PP
\&...will show the range of levels in source.vdf's dataset, as well as all timesteps
below 30. It will also list all variables except for bx and bz. If the dataset has
no timesteps at or above 30, vdfcp.pl will print an error message and exit.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
vdfcreate, wrf2vdf,
.PP
\&\fICopy a \s-1VDC\s0 to a new location\fR
.SH "HISTORY"
.IX Header "HISTORY"
Last updated on \f(CW$Date\fR$
