Imported Upstream version 2.6.1p1
[debian/amanda] / man / amsamba.8
1 '\" t
2 .\"     Title: amsamba
3 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
5 .\"      Date: 04/10/2009
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 2.6.1p1
8 .\"  Language: English
9 .\"
10 .TH "AMSAMBA" "8" "04/10/2009" "Amanda 2\&.6\&.1p1" "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 amsamba \- Amanda Application to interface with smbclient
23 .SH "DESCRIPTION"
24 .PP
25 Amsamba is an
26 \fIAmanda\fR
27 Application API script\&. It should not be run by users directly\&. It uses smbclient to backup and restore data\&.
28 .PP
29 The device name in the disklist must have the form \'//HOST/SHARE/SUBDIR\' where HOST is the CIFS host, SHARE is the share to connect and subdir is the subdirectory to backup\&. \'/subdir\' can be ommited, in which case the complete share is archived\&. The host in the disklist should be the name of an intermediate host that has smbclient installed, and is often the Amanda server itself\&.
30 .PP
31 Include or exclude can be used, but not both\&. The path for \'exclude list\' or \'include list\' must be absolute path on the client\&. The estimate calculates the complete size of the share, without regard for include or exclude directives\&. It will be larger than the actual dump if you use include or exclude\&. Using \'estimate server\' in the dumptype could give better estimate\&.
32 .SH "PROPERTIES"
33 .PP
34 This section lists the properties that control amsamba\'s functionality\&. See
35 \fBamanda-applications\fR(7)
36 for information on application properties and how they are configured\&.
37 .PP
38 SMBCLIENT\-PATH
39 .RS 4
40
41 The path to the smbclient binary\&.  The default is set when \fIAmanda\fR is built\&.
42 .RE
43 .PP
44 GNUTAR\-PATH
45 .RS 4
46
47 The path to the gnutar binary\&.  The default is set when \fIAmanda\fR is built\&. gnutar
48 is use to create the index\&.
49 .RE
50 .PP
51 AMANDAPASS
52 .RS 4
53
54 Location of the amandapass file, The default is "/etc/amandapass"\&.
55 The format of the file is as follow:
56 .nf
57   Sharename User%Password Domain
58 .fi
59
60 Sharename is \'//HOST/SHARE\' without the SUBDIR\&.
61 Sharename can be quoted,
62 it can be \'*\' to match all share,
63 it can be \'//pc\-host/*\' to match all share on pc\-host\&.
64 User is the username use to connect to the share\&.
65 Password is the password use to connect to the share\&.
66 Domain is optional\&. Example:
67 .nf
68   //another\-pc/share otheruser%otherpw domain
69 .fi
70 .RE
71 .SH "SEE ALSO"
72 .PP
73
74 \fBamanda.conf\fR(5),
75 \fBamanda-applications\fR(7)
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