amvault/amvault.8 documentation updates
Nathan Stratton Treadway <[email protected]> Thu, 21 Sep 2017 17:37:53 -0400
| Newsgroups | gmane.comp.archivers.amanda.devel |
|---|---|
| Message-ID | <[email protected]> |
The attached edits to amvault.pl and amvault.8.xml attempt to update the amvault "usage" screen and man page to better match each other as well as the actual behavior of the program. (again, this is starting from Amanda 3.4.5) (Jean-Louis,) Is there a particular reason that --src-labelstr isn't sufficient as a filter by itself? In my testing I can vault all dumps on one particular source volume by saying something like "amvault ... --src-labelstr TESTBACKUP-20 \*" .... but I'm wondering if it would be possible for --src-labelstr to be added to the "at least one of these filters is required" list? Thanks. Nathan ---------------------------------------------------------------------------- Nathan Stratton Treadway - [email protected] - Mid-Atlantic region Ray Ontko & Co. - Software consulting services - http://www.ontko.com/ GPG Key: http://www.ontko.com/~nathanst/gpg_key.txt ID: 1023D/ECFB6239 Key fingerprint = 6AD8 485E 20B9 5C71 231C 0C32 15F3 ADCD ECFB 6239
amvault_doc_updates_20170921.patch
(text/x-diff, 4.9 KB)
diff --git a/man/xml-source/amvault.8.xml b/man/xml-source/amvault.8.xml
index 87f5502..b819607 100644
--- a/man/xml-source/amvault.8.xml
+++ b/man/xml-source/amvault.8.xml
@@ -89,7 +89,7 @@ timestamp <option>src-timestamp</option> onto volumes using the storage
<para>The dumps to be read from secondary media can be specified by any
combination of dump specifications, <option>--fulls-only</option>,
-<option>--incrs-only</option>, and
+<option>--latest-fulls</option>, <option>--incrs-only</option>, and
<option>--src-timestamp</option>. At least one must be specified, lest
amvault attempt to vault all dumps in the catalog. See <manref
name="amanda-match" vol="7"/> for more information on dump
@@ -132,7 +132,12 @@ parameters there. Then reference that tapetype in the amvault invocation:
<varlistentry>
<term><option>--dest-storage</option> <replaceable>dest-storage</replaceable></term>
<listitem>
-<para>Dumps are written to that storage</para>
+<para>The vaulted dumps are written to the specified storage.</para>
+
+<para>If the <replaceable>vault-storage</replacable> option is specified
+in &amconf;, amvault will use that storage as the default destination.
+If not, a destination storage must be specific on the amvault command
+line.</para>
</listitem>
</varlistentry>
@@ -184,22 +189,32 @@ import/export slots, where they can be more easily removed by an operator.
<varlistentry>
<term><option>--no-interactivity</option></term>
<listitem>
-<para>Disable interactivity if a source volume is not found.</para>
+<para>Disable interactivity if a source or destination volume is not
+found.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--quiet</option></term><term><option>-q</option></term>
<listitem>
-<para>Eliminate non-error messages, and is useful when running amvault from
-cron.</para>
+<para>Suppress the progress messages normally printed to the terminal
+as dumps are being copied.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--src-labelstr</option> <replaceable>labelstr</replaceable></term>
+ <listitem>
+<para>Only dumps from volumes matching labelstr are copied.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--src-storage</option> <replaceable>src-storage</replaceable></term>
<listitem>
-<para>Dumps are read only from that storage</para>
+<para>Only dumps found on the specified storage are copied.
+(If this option is not given, all available source storages will be
+searched.)</para>
</listitem>
</varlistentry>
diff --git a/server-src/amvault.pl b/server-src/amvault.pl
index e0d2ecf..cba7eee 100644
--- a/server-src/amvault.pl
+++ b/server-src/amvault.pl
@@ -118,25 +118,34 @@ sub usage {
**NOTE** this interface is under development and will change in future releases!
Usage: amvault [-o configoption...] [-q] [--quiet] [-n] [--dry-run]
- [--fulls-only] [--latest-fulls] [--incrs-only] [--export]
- [--src-timestamp src-timestamp] [--exact-match]
- [--src-storage storage] [--dest-storage storage]
+ [--exact-match] [--export] [--no-interactivity]
+ [--src-labelstr labelstr] [--src-storage storage]
+ [--dest-storage storage]
+ [--fulls-only] [--latest-fulls] [--incrs-only]
+ [--src-timestamp src-timestamp]
config
[hostname [ disk [ date [ level [ hostname [...] ] ] ] ]]
-o: configuration override (see amanda(8))
- -q: quiet progress messages
+ -q/--quiet: quiet progress messages
+
+ --dest-storage: destination storage for vaulting operation
+
+ --exact-match: parse host and disk as exact values
+ --export: move completed destination volumes to import/export slots
+ --src-labelstr: only copy dumps from volumes matching labelstr
+ --src-storage: only copy dumps from specified storage
+
--fulls-only: only copy full (level-0) dumps
--latest-fulls: copy the latest full of every dle
--incrs-only: only copy incremental (level > 0) dumps
- --export: move completed destination volumes to import/export slots
--src-timestamp: the timestamp of the Amanda run that should be vaulted
-Copies data on storage src-storage from the run with timestamp <src-timestamp>
-onto volumes on the storage <dest-storage>. If <src-timestamp> is "latest",
-then the most recent run of amdump or amflush will be used. If any dumpspecs
-are included (<host-expr> and so on), then only dumps matching those dumpspecs
-will be dumped. At least one of --fulls-only, --src-timestamp, or a dumpspec
+Copies dumps selected by the specified filters onto volumes on the storage
+<dest-storage>. If <src-timestamp> is "latest", then the most recent run of
+amdump or amflush will be used. If any dumpspecs are included (<host-expr> and
+so on), then only dumps matching those dumpspecs will be dumped. At least one
+of --fulls-only, --latest-fulls, --incrs-only, --src-timestamp, or a dumpspec
must be specified.
EOF