lintian doesn't like orphan packages with uploaders...

[debian/amanda] / man / amvault.8

diff --git a/man/amvault.8 b/man/amvault.8
index 5b36e393d5b97e561cd479d74e6b948ea3659a5d..2d23cc6f0ec71c7fdecdcce0a63a06a53b43be6c 100644 (file)
--- a/man/amvault.8
+++ b/man/amvault.8
@@ -1,161 +1,22 @@
+'\" t

 .\"     Title: amvault
 .\"    Author: Dustin J. Mitchell <dustin@zmanda.com>
 .\"     Title: amvault
 .\"    Author: Dustin J. Mitchell <dustin@zmanda.com>

-.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
-.\"      Date: 01/22/2009
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 01/10/2013

 .\"    Manual: System Administration Commands
 .\"    Manual: System Administration Commands

-.\"    Source: Amanda 2.6.1
+.\"    Source: Amanda 3.3.3

 .\"  Language: English
 .\"
 .\"  Language: English
 .\"

-.TH "AMVAULT" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
+.TH "AMVAULT" "8" "01/10/2013" "Amanda 3\&.3\&.3" "System Administration Commands"

 .\" -----------------------------------------------------------------
 .\" -----------------------------------------------------------------

-.\" * (re)Define some macros
+.\" * Define some portability stuff

 .\" -----------------------------------------------------------------
 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .\" -----------------------------------------------------------------
 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-.\" toupper - uppercase a string (locale-aware)
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html

 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-.de toupper
-.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
-\\$*
-.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SH-xref - format a cross-reference to an SH section
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de SH-xref
-.ie n \{\
-.\}
-.toupper \\$*
-.el \{\
-\\$*
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SH - level-one heading that works better for non-TTY output
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de1 SH
-.\" put an extra blank line of space above the head in non-TTY output
-.if t \{\
-.sp 1
-.\}
-.sp \\n[PD]u
-.nr an-level 1
-.set-an-margin
-.nr an-prevailing-indent \\n[IN]
-.fi
-.in \\n[an-margin]u
-.ti 0
-.HTML-TAG ".NH \\n[an-level]"
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-\." make the size of the head bigger
-.ps +3
-.ft B
-.ne (2v + 1u)
-.ie n \{\
-.\" if n (TTY output), use uppercase
-.toupper \\$*
-.\}
-.el \{\
-.nr an-break-flag 0
-.\" if not n (not TTY), use normal case (not uppercase)
-\\$1
-.in \\n[an-margin]u
-.ti 0
-.\" if not n (not TTY), put a border/line under subheading
-.sp -.6
-\l'\n(.lu'
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SS - level-two heading that works better for non-TTY output
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de1 SS
-.sp \\n[PD]u
-.nr an-level 1
-.set-an-margin
-.nr an-prevailing-indent \\n[IN]
-.fi
-.in \\n[IN]u
-.ti \\n[SN]u
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.ps \\n[PS-SS]u
-\." make the size of the head bigger
-.ps +2
-.ft B
-.ne (2v + 1u)
-.if \\n[.$] \&\\$*
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" BB/BE - put background/screen (filled box) around block of text
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de BB
-.if t \{\
-.sp -.5
-.br
-.in +2n
-.ll -2n
-.gcolor red
-.di BX
-.\}
-..
-.de EB
-.if t \{\
-.if "\\$2"adjust-for-leading-newline" \{\
-.sp -1
-.\}
-.br
-.di
-.in
-.ll
-.gcolor
-.nr BW \\n(.lu-\\n(.i
-.nr BH \\n(dn+.5v
-.ne \\n(BHu+.5v
-.ie "\\$2"adjust-for-leading-newline" \{\
-\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
-.\}
-.el \{\
-\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
-.\}
-.in 0
-.sp -.5v
-.nf
-.BX
-.in
-.sp .5v
-.fi
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" BM/EM - put colored marker in margin next to block of text
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de BM
-.if t \{\
-.br
-.ll -2n
-.gcolor red
-.di BX
-.\}
-..
-.de EM
-.if t \{\
-.br
-.di
-.ll
-.gcolor
-.nr BH \\n(dn
-.ne \\n(BHu
-\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
-.in 0
-.nf
-.BX
-.in
-.fi
-.\}
-..
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '

 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------


@@ -166,36 +27,83 @@
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------

-.SH "Name"
-amvault \- Copy \fIAmanda\fR dumps from one volume to another
-.SH "Synopsis"
-.fam C
+.SH "NAME"
+amvault \- Copy Amanda dumps from one volume to another
+.SH "SYNOPSIS"

 .HP \w'\fBamvault\fR\ 'u
 .HP \w'\fBamvault\fR\ 'u

-\fBamvault\fR [\-o\ \fIconfigoption\fR]... \fIconfig\fR \fIsrc\-run\-timestamp\fR \fIdst\-changer\fR \fIlabel\-template\fR
-.fam
+\fBamvault\fR [\fB\-o\fR\ \fIconfigoption\fR...] [\-\-dry\-run | \-n] [\-\-quiet | \-q] [\-\-fulls\-only] [\-\-exact\-match] [\-\-export] [\fB\-\-src\-timestamp\fR\ \fIsrc\-timestamp\fR]
+.br
+\fB\-\-label\-template\fR\ \fIlabel\-template\fR \fB\-\-dst\-changer\fR\ \fIdst\-changer\fR [\fB\-\-autolabel\fR\ \fIautolabel\-arg\fR...]
+.br
+\fIconfig\fR [\fIhostname\fR\ [\ \fIdisk\fR\ [\ \fIdate\fR\ [\ \fIlevel\fR\ [\ \fIhostname\fR\ [\&.\&.\&.]\ ]\ ]\ ]\ ]]

 .SH "WARNING"
 .PP
 This application is not yet in its final form, and is subject to major revision in subsequent versions of Amanda\&. Backward compatibility is not guaranteed\&.
 .PP
 .SH "WARNING"
 .PP
 This application is not yet in its final form, and is subject to major revision in subsequent versions of Amanda\&. Backward compatibility is not guaranteed\&.
 .PP

-The significant limitations of this version of amvault are: tapetypes for secondary and tertiary volumes much match (including length and device_properties); tertiary volumes must be blank (manual erasure is required to re\-use tertiary media; restore/recover operations will request tertiary media by label when dumpfiles are not found on secondary media, but there is no provision to automatically fetch such media from a different changer; and all dumpfiles on a secondary volume are moved to tertiary media \- there is no provision to filter dumps\&.
+Note that Amanda restore/recover operations will request tertiary media by label when dumpfiles are not found on secondary media, but there is no provision to automatically fetch such media from a different changer

 .PP
 Feedback on and patches to this application are invited and encouraged!
 .SH "DESCRIPTION"
 .PP
 .PP
 Feedback on and patches to this application are invited and encouraged!
 .SH "DESCRIPTION"
 .PP

+Amvault is conceptually equivalent to "amfetchdump | taper"\&. That is, it reads specified dumps from secondary media and re\-writes them on tertiary media\&.
+.PP

 \fBAmvault\fR
 Copies data from the run with timestamp
 \fBAmvault\fR
 Copies data from the run with timestamp

-\fIsrc\-run\-timestamp\fR
+\fBsrc\-timestamp\fR

 onto volumes using the changer
 onto volumes using the changer

-\fIdst\-changer\fR, labeling new volumes with
-\fIlabel\-template\fR\&. If
-\fIsrc\-run\-timestamp\fR
-is "latest", then the most recent amdump or amflush run will be used\&.
+\fBdst\-changer\fR, and labeling new volumes with
+\fBlabel\-template\fR\&.
+.SS "Secondary Media"

 .PP
 .PP

-In a vaulting operation, the source media is referred to as "secondary media", while the destination is referred to as "tertiary media"\&.
+The dumps to be read from secondary media can be specified by any combination of dump specifications,
+\fB\-\-fulls\-only\fR, and
+\fB\-\-src\-timestamp\fR\&. At least one must be specified, lest amvault attempt to vault all dumps in the catalog\&. See
+\fBamanda-match\fR(7)
+for more information on dump specifications\&.

 .PP
 .PP

-Each source volume will be copied to a new destination volume; no re\-assembly or splitting will be performed\&. Destination volumes must be at least as large as the source volumes\&.
+Note that the datestamp given in the dumpspec is the
+\fIdump\fR
+datestamp \- the run in which the backup was taken on the Amanda client\&. The
+\fB\-\-src\-timestamp\fR, on the other hand, is the
+\fIwrite\fR
+timestamp \- the run in which the dump was written to secondary media\&. The latter option facilitates duplicating the results of an entire backup run, including any dumps that might have been flushed from holding disk\&.
+.SS "Tertiary Media"

 .PP
 .PP

-The changer parameter should specify the name of a changer defined in
+The
+\fB\-\-dst\-changer\fR
+must be specified, and names the changer in which tertiary media are stored\&.
+.PP
+If
+\fBamanda.conf\fR(5)
+contains the new
+\fBpart\-size\fR
+splitting parameters, then amvault will use them without any additional configuration\&. However, if the configuration still uses the old splitting parameters (\fBtape_splitsize\fR,
+\fBsplit_diskbuffer\fR, and
+\fBfallback_splitsize\fR), then amvault will need some additional configuration in order to properly split dumps to tertiary media\&. To do so, specify a new tapetype in
+\fBamanda.conf\fR(5), say "TERTIARY", and set the
+\fBpart\-size\fR
+and other appropriate parameters there\&. Then reference that tapetype in the amvault invocation:
+.sp
+.nf
+    amvault \-otapetype=TERTIARY \&.\&.\&.
+.fi
+.SH "OPTIONS"
+.PP
+\fB\-\-autolabel\fR [any] [other\-config] [non\-amanda] [volume\-error] [empty]
+.RS 4
+Works just like the
+\fBautolabel\fR
+parameter in
+\fBamanda.conf\fR(5), and can be specified multiple times if necessary\&. The default is \*(Aqempty\*(Aq\&.
+.RE
+.PP
+\fB\-\-dst\-changer\fR \fIdst\-changer\fR
+.RS 4
+Specifies the changer in which tertiary media are stored\&. In general, this should be different from the secondary changer, to eliminate the possibility of overwriting secondary media with tertiary data\&.
+.sp
+The
+\fBdst\-changer\fR
+parameter should specify the name of a changer defined in

 \fBamanda.conf\fR(5)\&. For example:
 .sp
 .nf
 \fBamanda.conf\fR(5)\&. For example:
 .sp
 .nf


@@ -206,17 +114,75 @@ define changer vaulting_tape {
     changerfile "vaulting\-changer\&.conf"
 }
 .fi
     changerfile "vaulting\-changer\&.conf"
 }
 .fi

+.RE

 .PP
 .PP

-The label template functions identically to the
-\fIlabel\-new\-tapes\fR
-parameter in
-\fBamanda.conf\fR(5)\&.
+\fB\-\-dry\-run\fR, \fB\-n\fR
+.RS 4
+Cause amvault to print the dumps it would vault, but not actually perform any vaulting operations\&.
+.RE
+.PP
+\fB\-\-exact\-match\fR
+.RS 4
+The host and disk are parsed as exact values
+.RE
+.PP
+\fB\-\-export\fR
+.RS 4
+Cause amvault to attempt to move completed tertiary volumes to import/export slots, where they can be more easily removed by an operator\&.
+.RE
+.PP
+\fB\-\-\-fulls\-only\fR
+.RS 4
+Only full (level\-0) dumps are copied\&.
+.RE
+.PP
+\fB\-\-label\-template\fR \fIlabel\-template\fR
+.RS 4
+Specifies a label template which is used to generate new labels for tertiary volumes\&.
+.RE
+.PP
+\fB\-\-quiet\fR, \fB\-q\fR
+.RS 4
+Eliminate non\-error messages, and is useful when running amvault from cron\&.
+.RE
+.PP
+\fB\-\-src\-timestamps\fR \fIsrc\-timestamps\fR
+.RS 4
+Specifies the timestamps in the format \*(AqYYYYMMDDHHMMSS\*(Aq of the run to vault, can be "latest", then the most recent amdump or amflush run will be used\&.
+.RE
+.PP
+\fB\-o\fR \fIconfigoption\fR
+.RS 4
+See the "\fBCONFIGURATION OVERRIDE\fR" section in
+\fBamanda\fR(8)\&.
+.RE
+.SH "EXAMPLES"
+.PP
+Vault all dump written to tape in the latest amdump or amflush run:
+.nf
+$ amvault \-\-src\-timestamps latest \-\-label\-template "CONF\-%%%" \-\-dst\-changer vault\-changer CONF
+.fi
+.PP
+Vault all dump written on the run of December 7 2011 12:13:14 :
+.nf
+$ amvault \-\-src\-timestamps 20111207121314 \-\-label\-template "CONF\-%%%" \-\-dst\-changer vault\-changer CONF
+.fi
+.PP
+Vault all dump dumped on any run of December 7 2011:
+.nf
+$ amvault \-\-label\-template "CONF\-%%%" \-\-dst\-changer vault\-changer CONF \e* \e* 20111207
+.fi

 .SH "SEE ALSO"
 .PP
 .SH "SEE ALSO"
 .PP

-\fBamanda\fR(8)
-.SH "Author"
+\fBamanda\fR(8),
+\fBamanda-changers\fR(7),
+\fBamfetchdump\fR(8)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHOR"

 .PP
 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 .RS 4
 .PP
 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 .RS 4

-Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
+Zmanda, Inc\&. (http://www\&.zmanda\&.com)

 .RE
 .RE