"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
[
<!-- entities files to use -->
- <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
+ <!ENTITY % global_entities SYSTEM 'global.entities'>
%global_entities;
]>
<refmeta>
<refentrytitle>amrecover</refentrytitle>
<manvolnum>8</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
</refmeta>
<refnamediv>
<refname>amrecover</refname>
-<refpurpose>&A; index database browser</refpurpose>
+<refpurpose>Amanda index database browser</refpurpose>
</refnamediv>
+<refentryinfo>
+&author.alan;
+&author.sgw.xml;
+</refentryinfo>
<!-- body begins here -->
<refsynopsisdiv>
<cmdsynopsis>
<command>amrecover</command>
- <arg choice='opt'><arg choice='opt'>-C </arg><arg choice='plain'><replaceable>config</replaceable></arg></arg>
- <arg choice='opt'><arg choice='plain'>-s </arg><arg choice='plain'><replaceable>index-server</replaceable></arg></arg>
- <arg choice='opt'><arg choice='plain'>-t </arg><arg choice='plain'><replaceable>tape-server</replaceable></arg></arg>
- <arg choice='opt'><arg choice='plain'>-d </arg><arg choice='plain'><replaceable>tape-device</replaceable></arg></arg>
+ <arg choice='opt'>-s <replaceable>index-server</replaceable></arg>
+ <arg choice='opt'>-t <replaceable>tape-server</replaceable></arg>
+ <arg choice='opt'>-d <replaceable>tape-device</replaceable></arg>
+ <arg choice='opt'>-h <replaceable>hostname</replaceable></arg>
+ &configoverride.synopsis;
+ <arg choice='opt'>-C <replaceable>config</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>DESCRIPTION</title>
<para><emphasis remap='B'>Amrecover</emphasis>
-browses the database of &A; index files to determine which tapes
+browses the database of Amanda index files to determine which tapes
contain files to recover. Furthermore, it is able to recover files.</para>
<para>In order to restore files in place, you must invoke
the backed up filesystem will be created in the current directory.
See the examples below for details.</para>
+<para>Amrecover will read the <emphasis remap='B'>amanda-client.conf</emphasis> file and the <replaceable>config</replaceable><emphasis remap='B'>/amanda-client.conf</emphasis> file. If no configuration name is supplied on the command line, Amrecover will try the compiled-in default configuration ,usually <emphasis remap='B'>DailySet1</emphasis>.</para>
+
<para>See the
-<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-man page for more details about &A;.</para>
+<manref name="amanda" vol="8"/>
+man page for more details about Amanda.</para>
</refsect1>
<refsect1><title>OPTIONS</title>
-<note>The Default values are those set at compile-time.
+<note><para>The Default values are those set at compile-time.
Use <command>amrestore</command> to recover client-encrypted or
-client-custom-compressed tapes.</note>
+client-custom-compressed tapes.</para>
+</note>
<variablelist remap='TP'>
<varlistentry>
<term><emphasis remap='B'>[ -C ] config</emphasis></term>
<listitem>
-<para>&A; configuration.</para>
+<para>Amanda configuration.</para>
</listitem>
</varlistentry>
<varlistentry>
<para>Tape device to use on the tape server host.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>-h hostname</option></term>
+ <listitem>
+<para>Hostname to begin restoring; defaults to the system's hostname.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>-o</emphasis> <replaceable>clientconfigoption</replaceable></term>
+ <listitem>
+<para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
+ section in <manref name="amanda" vol="8"/>.</para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</refsect1>
+<refsect1><title>AUTH</title>
+<para>The default <emphasis remap='B'>auth</emphasis> is 'BSDTCP', you can set
+a different auth in the <emphasis remap='B'>amanda-client.conf</emphasis> file
+or by specifying the '-oauth=bsd' command line argument.</para>
+</refsect1>
+
<refsect1><title>COMMANDS</title>
<para><emphasis remap='B'>Amrecover</emphasis>
connects to the index server and then presents a command line prompt.
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>setdate YYYY-MM-DD</emphasis></term>
+ <term><emphasis remap='B'>setdate YYYY-MM-DD-HH-MM[-SS] | YYYY-MM-DD</emphasis></term>
<listitem>
-<para>Set the date (default: today).
+<para>Set the restore time (default: now).
File listing commands only return information on
backup images for this day,
for the day before with the next lower dump level,
1996-07-06 through 1997-07-08 were level 2 backups
</literallayout> <!-- .fi -->
-<para>then if 1997-07-08 is the requested date,
-files from the following days would be used:</para>
+<para>then the command <emphasis remap='B'>setdate 1997-07-08-00</emphasis>
+would yield files from the following days:</para>
<!-- .RS -->
<literallayout remap='.nf'>
<!-- .RE -->
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>setdisk <arg
- choice='plain'><replaceable>diskname</replaceable></arg> <arg
- choice='opt'><replaceable>mountpoint</replaceable></arg></emphasis></term>
+ <term><emphasis remap='B'>setdisk</emphasis> <emphasis remap='I'>diskname</emphasis> [<emphasis remap='I'>mountpoint</emphasis>]</term>
<listitem>
<para>Specifies which disk to consider
(default: the disk holding the working directory where
<emphasis remap='I'>Diskname</emphasis>
is the device name specified in the
<emphasis remap='I'>amanda.conf</emphasis>
-or
-<emphasis remap='I'>disklist</emphasis>
-configuration file.
+or &disklist;.
The disk must be local to the host.
If
<emphasis remap='I'>mountpoint</emphasis>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>listdisk [diskdevice]</emphasis></term>
+ <term><emphasis remap='B'>listhost</emphasis> [<emphasis remap='I'>diskdevice</emphasis>]</term>
+ <listitem>
+<para>List all
+<emphasis remap='B'>host</emphasis></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>listdisk</emphasis> [<emphasis remap='I'>diskdevice</emphasis>]</term>
<listitem>
<para>List all
<emphasis remap='B'>diskname</emphasis></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>settape [[server]:][tapedev|default]</emphasis></term>
+ <term><emphasis remap='B'>listproperty</emphasis></term>
<listitem>
-<para>Specifies the host to use as the tape server, and which of its tape
-devices to use.
-If the server is omitted, but the colon is not, the
-server name reverts to the configure-time
-default.
-If the tape device is omitted, it remains unchanged.
-To use the default tape device selected by the tape server, the word
-<emphasis remap='I'>default</emphasis>
-must be specified.
-If no argument is specified, or the argument is an
-empty string, no changes occur, and the current settings are
-displayed.</para>
+<para>List all
+<emphasis remap='B'>property</emphasis></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>setproperty</emphasis> [<emphasis remap='B'>append</emphasis>] [<emphasis remap='B'>priority</emphasis>] <emphasis remap='I'>name</emphasis> [<emphasis remap='I'>value</emphasis> ...]</term>
+ <listitem>
+<para>Set the property <emphasis remap='I'>name</emphasis> to the value <emphasis remap='I'>value</emphasis>.
+The <emphasis remap='B'>append</emphasis> keyword appends the <emphasis remap='I'>value</emphasis> to the values already set for this property.
+Without <emphasis remap='I'>value</emphasis>, the property is unset.
+The <emphasis remap='B'>priority</emphasis> keyword is unused, it is present for ease of copy/paste from application definition.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>setdevice</emphasis> [[-h <emphasis remap='I'>tape-server</emphasis>] <emphasis remap='I'>tapedev</emphasis>]</term>
+ <listitem>
+<para>Specifies the host to use as the tape server, and which of its tape devices to use.
+If the server is omitted, the server name reverts to the configure-time default.
+If the tape device is omitted, the default is used.</para>
<para>If you want amrecover to use your changer, the
<emphasis remap='I'>tapedev</emphasis>
-must be equal to the amrecover_changer setting on the server.</para>
+must be equal to the <amkeyword>amrecover-changer</amkeyword> setting on the server.</para>
-<para>If you need to change the protocol (tape:, rait:, file:, null:) then you
-must specify the hostname.</para>
+<para>Since device names contain colons, you must always specify the hostname.</para>
<programlisting>
settape 192.168.0.10:file:/file1
</programlisting>
-
<para>You can change the tape device when amrecover ask you to load the tape:</para>
<programlisting>
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>setmode mode</emphasis></term>
+ <term><emphasis remap='B'>setmode</emphasis> <emphasis remap='I'>mode</emphasis></term>
<listitem>
<para>Set the extraction mode for Samba shares.
If
is
<emphasis remap='B'>tar</emphasis>,
they are extracted on the local machine the same way tar volumes are extracted.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>settranslate</emphasis> [<emphasis remap='B'>on</emphasis>|<emphasis remap='B'>off</emphasis>]</term>
+ <listitem>
+<para>Default: on. Translate escaped octal value ('\000') in
+the index file to their corespondig characters, it improve the interface
+if amrecover is run in the same charset as the filename. Set it to
+<emphasis remap='B'>off</emphasis> if the charset of some filename is not compatible with the amrecover charset.</para>
</listitem>
</varlistentry>
<varlistentry>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>cd dir</emphasis></term>
+ <term><emphasis remap='B'>cd</emphasis> <emphasis remap='I'>dir</emphasis></term>
<listitem>
<para>Change the backup working directory to
<emphasis remap='I'>dir.</emphasis>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>cdx dir</emphasis></term>
+ <term><emphasis remap='B'>cdx</emphasis> <emphasis remap='I'>dir</emphasis></term>
<listitem>
<para>Like the
<emphasis remap='B'>cd</emphasis>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>lcd path</emphasis></term>
+ <term><emphasis remap='B'>lcd</emphasis> <emphasis remap='I'>path</emphasis></term>
<listitem>
<para>Change the
<command>amrecover</command>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>add item1 item2 ...</emphasis></term>
+ <term><emphasis remap='B'>add</emphasis> <emphasis remap='I'>item1 item2 ...</emphasis></term>
<listitem>
<para>Add the specified files or directories to the restore list.
Each item may have shell style wildcards.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>addx item1 item2 ...</emphasis></term>
+ <term><emphasis remap='B'>addx</emphasis> <emphasis remap='I'>item1 item2 ...</emphasis></term>
<listitem>
<para>Add the specified files or directories to the restore list.
Each item may be a regular expression.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>delete item1 item2 ...</emphasis></term>
+ <term><emphasis remap='B'>delete</emphasis> <emphasis remap='I'>item1 item2 ...</emphasis></term>
<listitem>
<para>Delete the specified files or directories from the restore list.
Each item may have shell style wildcards.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>deletex item1 item2 ...</emphasis></term>
+ <term><emphasis remap='B'>deletex</emphasis> <emphasis remap='I'>item1 item2 ...</emphasis></term>
<listitem>
<para>Delete the specified files or directories from the restore list.
Each item may be a regular expression.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>list file</emphasis></term>
+ <term><emphasis remap='B'>list</emphasis> <emphasis remap='I'>file</emphasis></term>
<listitem>
<para>Display the contents of the restore list.
If a file name is specified,
the restore list is written to that file.
-This can be used to manually extract the files from the &A; tapes with
+This can be used to manually extract the files from the Amanda tapes with
<emphasis remap='B'>amrestore</emphasis>.</para>
</listitem>
</varlistentry>
# cd /var/log
# ls -l syslog.7
syslog.7: No such file or directory
-# amrecover
+# amrecover MyConfig
AMRECOVER Version 2.4.2. Contacting server on oops ...
-220 oops &A; index server (2.4.2) ready.
+220 oops Amanda index server (2.4.2) ready.
Setting restore date to today (1997-12-09)
200 Working date set to 1997-12-09.
-200 Config set to daily.
+200 Config set to MyConfig.
200 Dump host set to this-host.some.org.
$CWD '/var/log' is on disk '/var' mounted at '/var'.
200 Disk set to /var.
AMRECOVER Version 2.4.2. Contacting server on oops ...
...
amrecover> history
-200- Dump history for config "daily" host "this-host.some.org" disk "/var"
+200- Dump history for config "MyConfig" host "this-host.some.org" disk "/var"
201- 1997-12-09 1 DMP015 9
201- 1997-12-08 1 DMP014 11
201- 1997-12-07 0 DMP013 22
Defaults to
<emphasis remap='I'>more</emphasis>
if PAGER is not set.</para>
+<para><envar>AMANDA_SERVER</envar>
+If set, $AMANDA_SERVER will be used as index-server.
+The value will take precedence over the compiled default,
+but will be overridden by the -s switch.
+</para>
+<para><envar>AMANDA_TAPE_SERVER</envar>
+If set, $AMANDA_TAPE_SERVER will be used as tape-server.
+The value will take precedence over the compiled default,
+but will be overridden by the -t switch.
+</para>
<!-- .RE -->
</refsect1>
-<refsect1><title>AUTHOR</title>
-<para>Alan M. McIvor <email>alan@kauri.auck.irl.cri.nz</email> : Original text</para>
-<para>&maintainer.sgw;: XML-conversion</para>
-</refsect1>
+<seealso>
+<manref name="amanda-client.conf" vol="5"/>
+<manref name="amrestore" vol="8"/>
+<manref name="amfetchdump" vol="8"/>
+<manref name="readline" vol="3"/>
+</seealso>
-<refsect1><title>SEE ALSO</title>
-<para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amfetchdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>readline</refentrytitle><manvolnum>3</manvolnum></citerefentry></para>
-</refsect1>
</refentry>
-
projects / debian / amanda / blobdiff