Imported Upstream version 3.1.0
[debian/amanda] / man / xml-source / amarchiver.8.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
4 [
5   <!-- entities files to use -->
6   <!ENTITY % global_entities SYSTEM 'global.entities'>
7   %global_entities;
8 ]>
9
10 <refentry id='amarchiver.8'>
11
12 <refmeta>
13 <refentrytitle>amarchiver</refentrytitle>
14 <manvolnum>8</manvolnum>
15 &rmi.source;
16 &rmi.version;
17 &rmi.manual.8;
18 </refmeta>
19 <refnamediv>
20 <refname>amarchiver</refname>
21 <refpurpose>Create, extract or list amanda archive</refpurpose>
22 </refnamediv>
23 <refentryinfo>
24 &author.dustin;
25 &author.jlm;
26 </refentryinfo>
27 <!-- body begins here -->
28 <refsynopsisdiv>
29 <cmdsynopsis>
30   <command>amarchiver</command>
31     <arg choice='plain'>--version|--create|--extract|--list</arg>
32     <arg choice='opt'>--verbose</arg>
33     <arg choice='opt'>--file <replaceable>file</replaceable></arg>
34     <arg choice='plain' rep='repeat'><arg choice='opt'><replaceable>filename</replaceable></arg></arg>
35 </cmdsynopsis>
36 </refsynopsisdiv>
37
38 <refsect1><title>DESCRIPTION</title>
39
40 <para><emphasis remap='B'>Amarchiver</emphasis> manipulates amanda archive
41 file.  On creation, amarchiver doesn't recurse into directories. If a filename
42 specifies a directory, it will be ignored.  If it specifies a character device,
43 amarchiver reads the device and archives the data.  If a filename specifies a
44 named pipe, amarchiver reads the named pipe and archives the data.</para>
45
46 <para>Note that this tool is more limited than the Amanda archive library, and
47 may not be appropriate for some archive files -- particularly those which use
48 non-strings in their filenames.</para>
49
50 </refsect1>
51
52 <refsect1><title>OPTIONS</title>
53 <variablelist remap='TP'>
54   <varlistentry>
55   <term><option>--version</option></term>
56   <listitem>
57 <para>print the amarchiver version</para>
58   </listitem>
59   </varlistentry>
60   <varlistentry>
61   <term><option>--create</option></term>
62   <listitem>
63
64 <para>Create an amanda archive. Only the supplied filenames are included.  With one <option>--verbose</option>, lists the filenames.  With two, lists the filenames and sizes.</para>
65
66   </listitem>
67   </varlistentry>
68   <varlistentry>
69   <term><option>--list</option></term>
70   <listitem>
71 <para>List the filenames in an amanda archive.  No additional filenames are allowed on the command line.</para>
72   </listitem>
73   </varlistentry>
74   <varlistentry>
75   <term><option>--extract</option></term>
76   <listitem>
77 <para>Extract an amanda archive.  If filenames are supplied, only those files are extracted.  Files are created in the current directory, suffixed with a dot ('.') and the attribute ID.</para>
78   </listitem>
79   </varlistentry>
80   <varlistentry>
81   <term><option>--verbose</option></term>
82   <listitem>
83 <para>Give more information.</para>
84   </listitem>
85   </varlistentry>
86   <varlistentry>
87   <term><option>--file</option> file</term>
88   <listitem>
89 <para>Create, list or extract from the given file instead of stdin/stdout.</para>
90   </listitem>
91   </varlistentry>
92 </variablelist>
93 </refsect1>
94
95 <seealso>
96 <manref name="amanda-archive-format" vol="5"/>
97 </seealso>
98
99 </refentry>