Imported Upstream version 3.3.0
[debian/amanda] / man / amsuntar.8
1 '\" t
2 .\"     Title: amsuntar
3 .\"    Author: Satya Ganga <gast@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
5 .\"      Date: 06/02/2011
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.3.0
8 .\"  Language: English
9 .\"
10 .TH "AMSUNTAR" "8" "06/02/2011" "Amanda 3\&.3\&.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 amsuntar \- Amanda Application to interface with native tar utility available on solaris platforms
23 .SH "DESCRIPTION"
24 .PP
25 Amsuntar is an Amanda Application API script\&. It should not be run by users directly\&. It uses Solaris bundled tar utility to backup and restore data\&. Currenty ACLs from ZFS file system can only be backed up using the solaris supplied tar utility\&.
26 .PP
27 Solaris 10 supports Role Based Access Control(RBAC) which is enabled by default\&. To run backup operations using sun tar utility by under privileged user like amandabackup, amandabackup user need to have proper roles and profiles, specially "Media Backup" profile/role\&. This can be done using \'usermod \-P "Media Backup" amandabackup\' command\&.
28 .SH "PROPERTIES"
29 .PP
30 This section lists the properties that control amsuntar\'s functionality\&. See
31 \fBamanda-applications\fR(7)
32 for information on application properties and how they are configured\&.
33 .PP
34 BLOCK\-SIZE
35 .RS 4
36
37 Optional tar read or write block size\&.  The default is 256\&.
38 .RE
39 .PP
40 DIRECTORY
41 .RS 4
42
43 If set, suntar will backup from that directory instead of the \fIdiskdevice\fR set by the DLE\&. On restore, the data is restore in that directory instead of the current working directory\&.
44 .RE
45 .PP
46 EXTENDED\-ATTRIBUTES
47 .RS 4
48
49 Include extended attributes in archive\&.  The default is YES\&.
50 .RE
51 .PP
52 EXTENDED\-HEADERS
53 .RS 4
54
55 Write tar file with extended headers\&. With this optiion the modification time
56 is maintained with a  granularity of microseconds,Long file names and file 
57 sizes greater than 8GB can be archived\&. The default is YES\&.
58 .RE
59 .PP
60 SUNTAR\-PATH
61 .RS 4
62
63 The path to the suntar binary\&. The default is set when Amanda is built\&.
64 .RE
65 .PP
66 LANG
67 .RS 4
68
69 Default LANG is "C"\&. suntar require an UTF\-8 LANG if you have UTF\-8 filename and it is configured for extended headers\&. A good value can be "en_US\&.UTF\-8" if that locale is installed on your machine\&.
70 .RE
71 .PP
72 NORMAL
73 .RS 4
74 List all regex (Perl Regular Expression syntax) that are normal output from sun tar\&. These output are in the "FAILED DUMP DETAILS" section of the email report if the dump result is STRANGE or FAILED\&. Default values:
75 .sp
76 .nf
77 is not a file\&. Not dumped\e$
78 same as archive file\e$
79 .fi
80 .sp
81 To treat one of these default patterns differently, specify it explicitly in a different property\&.
82 .RE
83 .PP
84 IGNORE
85 .RS 4
86 List all regex (Perl Regular Expression syntax) that amanda ignore\&. These output are never in the email report\&.
87 .RE
88 .PP
89 STRANGE
90 .RS 4
91 List all regex (Perl Regular Expression syntax) that are strange output from sun tar\&. The result of the dump is STRANGE if sun tar produce a strange output\&. These output are in the "FAILED DUMP DETAILS" section of the email report\&. Default values:
92 .sp
93 .nf
94 : invalid character in UTF\-8 conversion of 
95 : UTF\-8 conversion failed\&.\e$
96 .fi
97 .sp
98 To treat one of these default patterns differently, specify it explicitly in a different property\&.
99 .RE
100 .PP
101 ERROR
102 .RS 4
103 List all regex (perl Regular Expression syntax) that are error output from sun tar\&. All sun tar output that doesn\'t match a normal, ignore or strange regex are error by default\&. The result of the dump is FAILED if sun tar produce an error output\&. These output are in the "FAILED DUMP DETAILS" section of the email report\&. Default values:
104 .sp
105 .nf
106 : Permission denied\e$
107 .fi
108 .sp
109 To treat one of these default patterns differently, specify it explicitly in a different property\&.
110 .RE
111 .SH "SEE ALSO"
112 .PP
113 \fBamanda\fR(8),
114 \fBamanda.conf\fR(5),
115 \fBamanda-applications\fR(7)
116 .PP
117 The Amanda Wiki:
118 : http://wiki.zmanda.com/
119 .SH "AUTHORS"
120 .PP
121 \fBSatya Ganga\fR <\&gast@zmanda\&.com\&>
122 .RS 4
123 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
124 .RE
125 .PP
126 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
127 .RS 4
128 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
129 .RE
130 .PP
131 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
132 .RS 4
133 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
134 .RE