+'\" t
.\" Title: amsamba
.\" Author: Jean-Louis Martineau <martineau@zmanda.com>
-.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
-.\" Date: 01/22/2009
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 01/10/2013
.\" Manual: System Administration Commands
-.\" Source: Amanda 2.6.1
+.\" Source: Amanda 3.3.3
.\" Language: English
.\"
-.TH "AMSAMBA" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
+.TH "AMSAMBA" "8" "01/10/2013" "Amanda 3\&.3\&.3" "System Administration Commands"
.\" -----------------------------------------------------------------
-.\" * (re)Define some macros
+.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" toupper - uppercase a string (locale-aware)
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de toupper
-.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
-\\$*
-.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SH-xref - format a cross-reference to an SH section
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de SH-xref
-.ie n \{\
-.\}
-.toupper \\$*
-.el \{\
-\\$*
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SH - level-one heading that works better for non-TTY output
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de1 SH
-.\" put an extra blank line of space above the head in non-TTY output
-.if t \{\
-.sp 1
-.\}
-.sp \\n[PD]u
-.nr an-level 1
-.set-an-margin
-.nr an-prevailing-indent \\n[IN]
-.fi
-.in \\n[an-margin]u
-.ti 0
-.HTML-TAG ".NH \\n[an-level]"
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-\." make the size of the head bigger
-.ps +3
-.ft B
-.ne (2v + 1u)
-.ie n \{\
-.\" if n (TTY output), use uppercase
-.toupper \\$*
-.\}
-.el \{\
-.nr an-break-flag 0
-.\" if not n (not TTY), use normal case (not uppercase)
-\\$1
-.in \\n[an-margin]u
-.ti 0
-.\" if not n (not TTY), put a border/line under subheading
-.sp -.6
-\l'\n(.lu'
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SS - level-two heading that works better for non-TTY output
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de1 SS
-.sp \\n[PD]u
-.nr an-level 1
-.set-an-margin
-.nr an-prevailing-indent \\n[IN]
-.fi
-.in \\n[IN]u
-.ti \\n[SN]u
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.ps \\n[PS-SS]u
-\." make the size of the head bigger
-.ps +2
-.ft B
-.ne (2v + 1u)
-.if \\n[.$] \&\\$*
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" BB/BE - put background/screen (filled box) around block of text
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de BB
-.if t \{\
-.sp -.5
-.br
-.in +2n
-.ll -2n
-.gcolor red
-.di BX
-.\}
-..
-.de EB
-.if t \{\
-.if "\\$2"adjust-for-leading-newline" \{\
-.sp -1
-.\}
-.br
-.di
-.in
-.ll
-.gcolor
-.nr BW \\n(.lu-\\n(.i
-.nr BH \\n(dn+.5v
-.ne \\n(BHu+.5v
-.ie "\\$2"adjust-for-leading-newline" \{\
-\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
-.\}
-.el \{\
-\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
-.\}
-.in 0
-.sp -.5v
-.nf
-.BX
-.in
-.sp .5v
-.fi
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" BM/EM - put colored marker in margin next to block of text
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de BM
-.if t \{\
-.br
-.ll -2n
-.gcolor red
-.di BX
-.\}
-..
-.de EM
-.if t \{\
-.br
-.di
-.ll
-.gcolor
-.nr BH \\n(dn
-.ne \\n(BHu
-\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
-.in 0
-.nf
-.BX
-.in
-.fi
-.\}
-..
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
-.SH "Name"
+.SH "NAME"
amsamba \- Amanda Application to interface with smbclient
.SH "DESCRIPTION"
.PP
-Amsamba is an
-\fIAmanda\fR
-Application API script\&. It should not be run by users directly\&. It uses smbclient to backup and restore data\&.
+Amsamba is an Amanda Application API script\&. It should not be run by users directly\&. It uses smbclient to backup and restore data\&.
.PP
-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\&.
+The
+\fBdiskdevice\fR
+in the disklist (DLE) must have the form \*(Aq//CIFSHOST/SHARE/SUBDIR\*(Aq where CIFSHOST is the CIFS host containing the data to be backed up, SHARE is the share to connect, and subdir is the subdirectory to backup\&. \*(Aq/subdir\*(Aq can be ommited, in which case the complete share is archived\&.
.PP
-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\&.
+Unlike most applications, amsamba backs up and restores data located on a different system from that where amsamba itself runs\&. The host containing the data is the CIFS host\&. In practice, amsamba is usually run on the same system as the Amanda server, with a DLE like
+.sp
+.nf
+localhost "//CIFSHOST/SHARENAME" amsamba\-dumptype
+.fi
+.PP
+Include or exclude can be used, but not both\&. The path for \*(Aqexclude list\*(Aq or \*(Aqinclude list\*(Aq must be absolute path on the CIFS host\&. 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 \*(Aqestimate server\*(Aq in the dumptype could give better estimate\&.
.SH "PROPERTIES"
.PP
-This section lists the properties that control amsamba\'s functionality\&. See
+This section lists the properties that control amsamba\*(Aqs functionality\&. See
\fBamanda-applications\fR(7)
for information on application properties and how they are configured\&.
.PP
SMBCLIENT\-PATH
.RS 4
-The path to the smbclient binary\&. The default is set when \fIAmanda\fR is built\&.
+The path to the smbclient binary\&. The default is set when Amanda is built by the
+\-\-with\-smbclient configure option\&.
.RE
.PP
GNUTAR\-PATH
.RS 4
-The path to the gnutar binary\&. The default is set when \fIAmanda\fR is built\&. gnutar
-is use to create the index\&.
+The path to the gnutar binary\&. The default is set when Amanda is built by the
+\-\-with\-gnutar configure option\&. gnutar is used to create the index\&.
.RE
.PP
AMANDAPASS
.RS 4
-Location of the amandapass file, The default is "/etc/amandapass"\&.
+Location of the amandapass file, defaulting to "$CONFIG_DIR/amandapass"\&.
+Relative pathnames are relative to the configuration directory,
+"$CONFIG_DIR/<config>"\&.
+Note that this file is located on the client, not on the server\&.
The format of the file is as follow:
.nf
Sharename User%Password Domain
.fi
-Sharename is \'//HOST/SHARE\' without the SUBDIR\&.
+Sharename is \*(Aq//HOST/SHARE\*(Aq without the SUBDIR\&.
Sharename can be quoted,
-it can be \'*\' to match all share,
-it can be \'//pc\-host/*\' to match all share on pc\-host\&.
+it can be \*(Aq*\*(Aq to match all share,
+it can be \*(Aq//pc\-host/*\*(Aq to match all share on pc\-host\&.
User is the username use to connect to the share\&.
Password is the password use to connect to the share\&.
+\*(Aq%Password\*(Aq is optional if the user can connect to the share without password\&.
+\*(AqUser%Password\*(Aq is optional, the user \*(Aqguest\*(Aq without password is use to connect to the share\&.
Domain is optional\&. Example:
.nf
//another\-pc/share otheruser%otherpw domain
+ //another\-pc/share otheruser%otherpw
+ //another\-pc/share myuser mydomain
+ //another\-pc/share myuser
+ //another\-pc/share
.fi
.RE
-.SH "SEE ALSO"
.PP
+ALLOW\-ANONYMOUS
+.RS 4
+
+This username without password is used to connect to the share if no matching entry is found in the amandapass file\&.
+.RE
+.PP
+DIRECTORY
+.RS 4
+For restore command only, the data is recoved in that directory\&. Must be a unix path for "tar" RECOVER\-MODE or a smb path for "smb" recover\-MODE\&.
+.RE
+.PP
+RECOVER\-MODE
+.RS 4
+
+"tar" or "smb", default to "tar"\&. If "tar", the data is recovered on the local machine, If "smb", the data is recovered on the smb client machine\&.
+.RE
+.SH "INCLUDE AND EXCLUDE LISTS"
+.PP
+This application supplies exclude lists via the
+\fBsmbclient\fR
+\fB\-TX\fR
+option\&. Normal shell\-style wildcard expressions, using * and ?, are not supported\&. All expressions are matched only from the base directory of the DLE\&. Expressions that match a directory may have a leading or trailing "/"\&. Example expressions:
+.sp
+.nf
+ \&./temp\-files # exclude top\-level dir "temp\-files" entirely
+ \&./temp\-files/ # same
+ /temp\-files # same
+ temp\-files # same
+ \&./temp\-files/* # BAD: does nothing
+ *\&.iso # BAD: does nothing
+ proxy/local/cache # exclude "cache" in dir "proxy/local"
+.fi
+.PP
+Include lists are supported only if excludes are not given\&. They are handled via the
+\fBsmbclient\fR
+\fB\-TI\fR
+option\&. Include matching is identical to the exclude matching described above\&.
+.SH "EXAMPLE"
+.nf
+ define application app_amsamba {
+ property "SMBCLIENT\-PATH" "/usr/bin/smbclient"
+ property "GNUTAR\-PATH" "/bin/tar"
+ property "AMANDAPASS" /etc/amandapass"
+ property "ALLOW\-ANONYMOUS" "guest"
+ }
+.fi
+.SH "SEE ALSO"
+.PP
+\fBamanda\fR(8),
\fBamanda.conf\fR(5),
\fBamanda-applications\fR(7)
-.SH "Author"
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHOR"
.PP
\fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
.RS 4
-Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
+Zmanda, Inc\&. (http://www\&.zmanda\&.com)
.RE
projects / debian / amanda / blobdiff