Imported Upstream version 3.2.0
[debian/amanda] / man / amraw.8
1 '\" t
2 .\"     Title: amraw
3 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
5 .\"      Date: 10/18/2010
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.2.0
8 .\"  Language: English
9 .\"
10 .TH "AMRAW" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 amraw \- Amanda Application open and read data
23 .SH "DESCRIPTION"
24 .PP
25 Amraw is an Amanda Application API script\&. It should not be run by users directly\&. It uses dd to backup and restore data\&.
26 .PP
27 Amraw can backup only one directory entry, it can be a single file, a raw device, anything that amanda can open and read\&.
28 .PP
29 Restore is done in place, an open is done and the data is written to it\&. A file owned by root and permission 0600 is create if the directory entry doesn\'t exist before the restore\&.
30 .PP
31 Only full backup is allowed
32 .SH "PROPERTIES"
33 .PP
34 This section lists the properties that control amgtar\'s functionality\&. See
35 \fBamanda-applications\fR(7)
36 for information on application properties and how they are configured\&.
37 .PP
38 DIRECTORY
39 .RS 4
40
41 Used only for restore command, can be a device name or file, the data will be restored to it\&.
42 .RE
43 .SH "EXAMPLE"
44 .PP
45
46 .sp
47 .nf
48   define application\-tool app_amraw {
49     plugin "amraw"
50   }
51 .fi
52 A dumptype using this application might look like:
53 .sp
54 .nf
55   define dumptype amraw {
56     global
57     program "APPLICATION"
58     application "app_amraw"
59   }
60 .fi
61 Note that the
62 \fIprogram\fR
63 parameter must be set to
64 \fI"APPLICATION"\fR
65 to use the
66 \fIapplication\fR
67 parameter\&.
68 .SH "SEE ALSO"
69 .PP
70 \fBamanda\fR(8),
71 \fBamanda.conf\fR(5),
72 \fBamanda-applications\fR(7)
73 .PP
74 The Amanda Wiki:
75 : http://wiki.zmanda.com/
76 .SH "AUTHOR"
77 .PP
78 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
79 .RS 4
80 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
81 .RE