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