X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famsamba.8;h=f797eae7349823bd8d3cd93feaa3d4c448db1280;hb=fd48f3e498442f0cbff5f3606c7c403d0566150e;hp=9a64fa9479ad5cbc3ba26b3b298a16f3f9251199;hpb=96f35b20267e8b1a1c846d476f27fcd330e0b018;p=debian%2Famanda diff --git a/man/amsamba.8 b/man/amsamba.8 index 9a64fa9..f797eae 100644 --- a/man/amsamba.8 +++ b/man/amsamba.8 @@ -2,12 +2,12 @@ .\" Title: amsamba .\" Author: Jean-Louis Martineau .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 -.\" Date: 11/05/2009 +.\" Date: 06/01/2010 .\" Manual: System Administration Commands -.\" Source: Amanda 2.6.1p2 +.\" Source: Amanda 3.1.0 .\" Language: English .\" -.TH "AMSAMBA" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "System Administration Commands" +.TH "AMSAMBA" "8" "06/01/2010" "Amanda 3\&.1\&.0" "System Administration Commands" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -22,13 +22,17 @@ 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 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\&. .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 \'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\&. .SH "PROPERTIES" .PP This section lists the properties that control amsamba\'s functionality\&. See @@ -38,20 +42,24 @@ for information on application properties and how they are configured\&. 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/"\&. +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 @@ -63,16 +71,73 @@ it can be \'*\' to match all share, it can be \'//pc\-host/*\' 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\&. 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) +.PP +The Amanda Wiki: +: http://wiki.zmanda.com/ .SH "AUTHOR" .PP \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>