Imported Upstream version 3.3.1
[debian/amanda] / man / amsamba.8
index 95be24d412503551acd392f897c792bd34ccc5d0..291e71f6d1fd6a878f7525a1f6bf9ac6cbb5870d 100644 (file)
@@ -1,13 +1,22 @@
 '\" t
 .\"     Title: amsamba
 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
-.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
-.\"      Date: 06/02/2011
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 02/21/2012
 .\"    Manual: System Administration Commands
-.\"    Source: Amanda 3.3.0
+.\"    Source: Amanda 3.3.1
 .\"  Language: English
 .\"
-.TH "AMSAMBA" "8" "06/02/2011" "Amanda 3\&.3\&.0" "System Administration Commands"
+.TH "AMSAMBA" "8" "02/21/2012" "Amanda 3\&.3\&.1" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -24,7 +33,9 @@ amsamba \- Amanda Application to interface with smbclient
 .PP
 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 \'//CIFSHOST/SHARE/SUBDIR\' 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\&. \'/subdir\' can be ommited, in which case the complete share is archived\&.
+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
 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
@@ -32,10 +43,10 @@ Unlike most applications, amsamba backs up and restores data located on a differ
 localhost "//CIFSHOST/SHARENAME" amsamba\-dumptype
 .fi
 .PP
-Include or exclude can be used, but not both\&. The path for \'exclude list\' or \'include list\' 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 \'estimate server\' in the dumptype could give better estimate\&.
+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
@@ -65,14 +76,14 @@ The format of the file is as follow:
   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\&.
-\'%Password\' is optional if the user can connect to the share without password\&.
-\'User%Password\' is optional, the user \'guest\' without password is 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