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