git.gag.com Git - debian/amanda/blob - man/xml-source/amsamba.8.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <refentry id='amsamba.8'>
  11
  12 <refmeta>
  13 <refentrytitle>amsamba</refentrytitle>
  14 <manvolnum>8</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.8;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amsamba</refname>
  21 <refpurpose>Amanda Application to interface with smbclient</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.jlm;
  25 </refentryinfo>
  26 <!-- body begins here -->
  27
  28 <refsect1><title>DESCRIPTION</title>
  29
  30 <para>Amsamba is an &A; Application API script.  It should not be run
  31 by users directly.  It uses smbclient to backup and restore data.</para>
  32
  33 <para>The device name in the disklist must have the form '//HOST/SHARE/SUBDIR'
  34 where HOST is the CIFS host, SHARE is the share to connect and subdir is the
  35 subdirectory to backup.  '/subdir' can be ommited, in which case the complete
  36 share is archived.  The host in the disklist should be the name of an
  37 intermediate host that has smbclient installed, and is often the Amanda server
  38 itself.</para>
  39
  40 <para>Include or exclude can be used, but not both. The path for 'exclude list'
  41 or 'include list' must be absolute path on the client. The estimate calculates
  42 the complete size of the share, without regard for include or exclude
  43 directives.  It will be larger than the actual dump if you use include or
  44 exclude.  Using 'estimate server' in the dumptype could give better
  45 estimate.</para>
  46
  47 </refsect1>
  48
  49 <refsect1><title>PROPERTIES</title>
  50
  51 <para>This section lists the properties that control amsamba's functionality.
  52 See <citerefentry><refentrytitle>amanda-applications</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  53 for information on application properties and how they are configured.</para>
  54
  55 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
  56 <variablelist>
  57  <!-- ==== -->
  58  <varlistentry><term>SMBCLIENT-PATH</term><listitem>
  59 The path to the smbclient binary.  The default is set when &A; is built.
  60 </listitem></varlistentry>
  61  <!-- ==== -->
  62  <varlistentry><term>GNUTAR-PATH</term><listitem>
  63 The path to the gnutar binary.  The default is set when &A; is built. gnutar
  64 is use to create the index.
  65 </listitem></varlistentry>
  66  <!-- ==== -->
  67  <varlistentry><term>AMANDAPASS</term><listitem>
  68 Location of the amandapass file, The default is "/etc/amandapass".
  69 The format of the file is as follow:
  70 <programlisting>
  71   Sharename User%Password Domain
  72 </programlisting>
  73 Sharename is '//HOST/SHARE' without the SUBDIR.
  74 Sharename can be quoted,
  75 it can be '*' to match all share,
  76 it can be '//pc-host/*' to match all share on pc-host.
  77 User is the username use to connect to the share.
  78 Password is the password use to connect to the share.
  79 Domain is optional. Example:
  80 <programlisting>
  81   //another-pc/share otheruser%otherpw domain
  82 </programlisting>
  83 </listitem></varlistentry>
  84 </variablelist>
  85
  86 </refsect1>
  87
  88 <refsect1><title>SEE ALSO</title>
  89 <para>
  90 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  91 <citerefentry><refentrytitle>amanda-applications</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  92 </para>
  93
  94 </refsect1>
  95 </refentry>