Imported Upstream version 3.3.2
[debian/amanda] / man / amanda-applications.7
1 '\" t
2 .\"     Title: amanda-applications
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: Miscellanea
7 .\"    Source: Amanda 3.3.2
8 .\"  Language: English
9 .\"
10 .TH "AMANDA\-APPLICATIONS" "7" "07/25/2012" "Amanda 3\&.3\&.2" "Miscellanea"
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 amanda-applications \- Application\-api for amanda
32 .SH "DESCRIPTION"
33 .PP
34 Describe how to use application with Amanda
35 .SH "APPLICATIONS"
36 .PP
37 This section lists the applications included with Amanda\&. See the individual man pages for instructions on using them\&. For complete How\-To information, consult the Amanda wiki at http://wiki\&.zmanda\&.com\&.
38 .sp
39 .RS 4
40 .ie n \{\
41 \h'-04'\(bu\h'+03'\c
42 .\}
43 .el \{\
44 .sp -1
45 .IP \(bu 2.3
46 .\}
47 \fBamgtar\fR(8),
48 \- use GNU Tar to backup and restore data\&.
49 .RE
50 .sp
51 .RS 4
52 .ie n \{\
53 \h'-04'\(bu\h'+03'\c
54 .\}
55 .el \{\
56 .sp -1
57 .IP \(bu 2.3
58 .\}
59 \fBampgsql\fR(8),
60 \- use PostgreSQL\*(Aqs continuous WAL archiving\&.
61 .RE
62 .sp
63 .RS 4
64 .ie n \{\
65 \h'-04'\(bu\h'+03'\c
66 .\}
67 .el \{\
68 .sp -1
69 .IP \(bu 2.3
70 .\}
71 \fBamraw\fR(8),
72 \- use open and read to read the data\&.
73 .RE
74 .sp
75 .RS 4
76 .ie n \{\
77 \h'-04'\(bu\h'+03'\c
78 .\}
79 .el \{\
80 .sp -1
81 .IP \(bu 2.3
82 .\}
83 \fBamsamba\fR(8),
84 \- use smbclient to backup and restore data\&.
85 .RE
86 .sp
87 .RS 4
88 .ie n \{\
89 \h'-04'\(bu\h'+03'\c
90 .\}
91 .el \{\
92 .sp -1
93 .IP \(bu 2.3
94 .\}
95 \fBamstar\fR(8),
96 \- use star to backup and restore data\&.
97 .RE
98 .sp
99 .RS 4
100 .ie n \{\
101 \h'-04'\(bu\h'+03'\c
102 .\}
103 .el \{\
104 .sp -1
105 .IP \(bu 2.3
106 .\}
107 \fBamsuntar\fR(8),
108 \- use native tar on Solaris to backup and restore data\&.
109 .RE
110 .sp
111 .RS 4
112 .ie n \{\
113 \h'-04'\(bu\h'+03'\c
114 .\}
115 .el \{\
116 .sp -1
117 .IP \(bu 2.3
118 .\}
119 \fBamzfs-sendrecv\fR(8),
120 \- use zfs to create a snapshot and use \*(Aqzfs send\*(Aq to generate the backup\&.
121 .RE
122 .sp
123 .RS 4
124 .ie n \{\
125 \h'-04'\(bu\h'+03'\c
126 .\}
127 .el \{\
128 .sp -1
129 .IP \(bu 2.3
130 .\}
131 \fBamzfs-snapshot\fR(8),
132 \- use zfs to create a snapshot and for use with other applications (e\&.g\&. amgtar)
133 .RE
134 .SH "DEFINING APPLICATIONS"
135 .PP
136 An application is defined in
137 \fBamanda.conf\fR(5)
138 as follows:
139 .sp
140 .nf
141 define application\-tool $appconfigname {
142    plugin "$pluginname"
143    property "$PROPERTY_NAME" "$PROPERTY_VALUE"
144    \&.\&.\&.
145 }
146 .fi
147 and then referenced in a dumptype as
148 .sp
149 .nf
150 define dumptype $dumptypename {
151    \&.\&.\&.
152    program "APPLICATION"
153    application "$appconfigname"
154 }
155 .fi
156 .PP
157 Application properties, like Amanda configuration parameters, are insensitive to case, and
158 \-
159 (dash) and
160 _
161 (underscore) may be used interchangeably\&.
162 .PP
163 See the individual plugin documentation for properties applicable to each plugin\&.
164 .SH "SEE ALSO"
165 .PP
166 \fBamanda\fR(8),
167 \fBamanda.conf\fR(5)
168 .PP
169 The Amanda Wiki:
170 : http://wiki.zmanda.com/
171 .SH "AUTHORS"
172 .PP
173 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
174 .RS 4
175 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
176 .RE
177 .PP
178 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
179 .RS 4
180 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
181 .RE