Imported Upstream version 2.5.1

[debian/amanda] / docs / amanda-client.conf.5.txt

diff --git a/docs/amanda-client.conf.5.txt b/docs/amanda-client.conf.5.txt
new file mode 100644 (file)
index 0000000..2444dc8
--- /dev/null
+++ b/docs/amanda-client.conf.5.txt
@@ -0,0 +1,121 @@
+
+                      amanda-client.conf
+Prev  Chapter 36. The Amanda Manual Pages.  Next
+
+-------------------------------------------------------------------------------
+
+Name
+
+amanda-client.conf \14 Client configuration file for Amanda, the Advanced
+Maryland Automatic Network Disk Archiver
+
+DESCRIPTION
+
+amanda-client.conf is the client configuration file for Amanda. This manpage
+lists the relevant sections and parameters of this file for quick reference.
+
+PARAMETERS
+
+There are a number of configuration parameters that control the behavior of the
+Amanda programs. All have default values, so you need not specify the parameter
+in amanda-client.conf if the default is suitable.
+Lines starting with # are ignored, as are blank lines. Comments may be placed
+on a line with a directive by starting the comment with a #. The remainder of
+the line is ignored.
+Keywords are case insensitive, i.e. auth and Auth are treated the same.
+Integer arguments may have one of the following (case insensitive) suffixes,
+some of which have a multiplier effect:
+
+POSSIBLE SUFFIXES
+
+
+
+  b byte bytes
+      Some number of bytes.
+
+  bps
+      Some number of bytes per second.
+
+  k kb kbyte kbytes kilobyte kilobytes
+      Some number of kilobytes (bytes*1024).
+
+  kps kbps
+      Some number of kilobytes per second (bytes*1024).
+
+  m mb meg mbyte mbytes megabyte megabytes
+      Some number of megabytes (bytes*1024*1024).
+
+  mps mbps
+      Some number of megabytes per second (bytes*1024*1024).
+
+  g gb gbyte gbytes gigabyte gigabytes
+      Some number of gigabytes (bytes*1024*1024*1024).
+
+  tape tapes
+      Some number of tapes.
+
+  day days
+      Some number of days.
+
+  week weeks
+      Some number of weeks (days*7).
+
+      Note
+
+      The value inf may be used in most places where an integer is expected to
+      mean an infinite amount.
+      Boolean arguments may have any of the values y, yes, t, true or on to
+      indicate a true state, or n, no, f, false or off to indicate a false
+      state. If no argument is given, true is assumed.
+
+
+PARAMETERS
+
+
+
+  conf string
+      Default: Set by configure. The conf use by amrecover.
+
+  index_server string
+      Default: Set by configure. The amindexd server amrecover will connect to.
+
+  tape_server string
+      Default: Set by configure. The amidxtaped server amrecover will connect
+      to.
+
+  tapedev string
+      Default: Set by configure. The tapedev amrecover will use.
+
+  auth string
+      Default: bsd. Type of authorization to perform between tape server and
+      backup client hosts.
+      bsd, bsd authorization with udp initial connection and one tcp connection
+      by data stream.
+      bsdtcp, bsd authorization but use only one tcp connection.
+      bsdudp, like bsd, but will use only one tcp connection for all data
+      stream.
+      krb4 to use Kerberos-IV authorization.
+      krb5 to use Kerberos-V authorization.
+      rsh to use rsh authorization.
+      ssh to use OpenSSH authorization.
+
+  ssh_keys string
+      Default: No default. The key file the ssh auth will use, it must be the
+      private key. If this parameter is not specified, then the deafult ssh key
+      will be used.
+
+
+AUTHOR
+
+James da Silva, <jds@amanda.org>: Original text
+Stefan G. Weichinger, <sgw@amanda.org>, maintainer of the Amanda-documentation:
+XML-conversion, major update, splitting
+
+SEE ALSO
+
+amanda(8), amanda.conf(5), amcrypt(8), aespipe(1),
+-------------------------------------------------------------------------------
+
+Prev          Up      Next
+amanda.conf  Home  amcheck
+