Imported Upstream version 2.5.1
[debian/amanda] / man / amanda-client.conf.5
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "AMANDA-CLIENT.CONF" 5 "" "" ""
21 .SH "NAME"
22 amanda-client.conf - Client configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
23 .SH "DESCRIPTION"
24 .PP
25 \fIamanda-client.conf\fR
26 is the client configuration file for
27 \fBAmanda\fR. This manpage lists the relevant sections and parameters of this file for quick reference.
28 .PP
29 The files
30 \fB<CONFIG_DIR>/amanda-client.conf\fR
31 and
32 \fB<CONFIG_DIR>/<config>/amanda-client.conf\fR
33 are loaded.
34 .SH "PARAMETERS"
35 .PP
36 There are a number of configuration parameters that control the behavior of the
37 \fBAmanda\fR
38 programs. All have default values, so you need not specify the parameter in
39 \fBamanda-client.conf\fR
40 if the default is suitable.
41 .PP
42 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.
43 .PP
44 Keywords are case insensitive, i.e.
45 \fBauth\fR
46 and
47 \fBAuth\fR
48 are treated the same.
49 .PP
50 Integer arguments may have one of the following (case insensitive) suffixes, some of which have a multiplier effect:
51 .SS "POSSIBLE SUFFIXES"
52 .TP
53 \fBb byte bytes\fR
54 Some number of bytes.
55 .TP
56 \fBbps\fR
57 Some number of bytes per second.
58 .TP
59 \fBk kb kbyte kbytes kilobyte kilobytes\fR
60 Some number of kilobytes (bytes*1024).
61 .TP
62 \fBkps kbps\fR
63 Some number of kilobytes per second (bytes*1024).
64 .TP
65 \fBm mb meg mbyte mbytes megabyte megabytes\fR
66 Some number of megabytes (bytes*1024*1024).
67 .TP
68 \fBmps mbps\fR
69 Some number of megabytes per second (bytes*1024*1024).
70 .TP
71 \fBg gb gbyte gbytes gigabyte gigabytes\fR
72 Some number of gigabytes (bytes*1024*1024*1024).
73 .TP
74 \fBtape tapes\fR
75 Some number of tapes.
76 .TP
77 \fBday days\fR
78 Some number of days.
79 .TP
80 \fBweek weeks\fR
81 Some number of weeks (days*7).
82 .sp
83 .it 1 an-trap
84 .nr an-no-space-flag 1
85 .nr an-break-flag 1
86 .br
87 \fBNote\fR
88 The value
89 \fBinf\fR
90 may be used in most places where an integer is expected
91 to mean an infinite amount.
92
93 Boolean arguments may have any of the values
94 \fBy\fR,
95 \fByes\fR,
96 \fBt\fR,
97 \fBtrue\fR
98 or
99 \fBon\fR
100 to indicate a true state, or
101 \fBn\fR,
102 \fBno\fR,
103 \fBf\fR,
104 \fBfalse\fR
105 or
106 \fBoff\fR
107 to indicate a false state. If no argument is given,
108 \fBtrue\fR
109 is assumed.
110 .SS "PARAMETERS"
111 .TP
112 \fBconf\fR \fB string\fR
113 Default:
114 \fBSet by configure\fR. The conf use by amrecover.
115 .TP
116 \fBindex_server\fR \fB string\fR
117 Default:
118 \fBSet by configure\fR. The amindexd server amrecover will connect to.
119 .TP
120 \fBtape_server\fR \fB string\fR
121 Default:
122 \fBSet by configure\fR. The amidxtaped server amrecover will connect to.
123 .TP
124 \fBtapedev\fR \fB string\fR
125 Default:
126 \fBSet by configure\fR. The tapedev amrecover will use.
127 .TP
128 \fBauth\fR \fB string\fR
129 Default:
130 \fBbsd\fR. Type of authorization to perform between tape server and backup client hosts.
131 .sp
132 \fBbsd\fR, bsd authorization with udp initial connection and one tcp connection by data stream.
133 .sp
134 \fBbsdtcp\fR, bsd authorization but use only one tcp connection.
135 .sp
136 \fBbsdudp\fR, like bsd, but will use only one tcp connection for all data stream.
137 .sp
138 \fBkrb4\fR
139 to use Kerberos-IV authorization.
140 .sp
141 \fBkrb5\fR
142 to use Kerberos-V authorization.
143 .sp
144 \fBrsh\fR
145 to use rsh authorization.
146 .sp
147 \fBssh\fR
148 to use OpenSSH authorization.
149 .TP
150 \fBssh_keys\fR \fB string\fR
151 Default:
152 \fBNo default\fR. 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.
153 .TP
154 \fBgnutar_list_dir\fR \fB string\fR
155 Default from configure
156 \fB--with-gnutar-listdir=DIR\fR. The directory where gnutar keep its state file.
157 .TP
158 \fBamandates\fR \fB string\fR
159 Default:
160 \fB/etc/amandates\fR. The file where amanda keep the last date of each dumplevel.
161 .SH "AUTHOR"
162 .PP
163 James da Silva,
164 <jds@amanda.org>: Original text
165 .PP
166 Stefan G. Weichinger,
167 <sgw@amanda.org>, maintainer of the
168 \fBAmanda\fR-documentation: XML-conversion, major update, splitting
169 .SH "SEE ALSO"
170 .PP
171 \fBamanda\fR(8),
172 \fBamanda.conf\fR(5),
173 \fBamcrypt\fR(8),
174 \fBaespipe\fR(1),
175