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