Imported Upstream version 2.6.1
[debian/amanda] / man / amanda.8
1 .\"     Title: amanda
2 .\"    Author: James da Silva <jds@amanda.org>
3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4 .\"      Date: 01/22/2009
5 .\"    Manual: System Administration Commands
6 .\"    Source: Amanda 2.6.1
7 .\"  Language: English
8 .\"
9 .TH "AMANDA" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
10 .\" -----------------------------------------------------------------
11 .\" * (re)Define some macros
12 .\" -----------------------------------------------------------------
13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 .\" toupper - uppercase a string (locale-aware)
15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16 .de toupper
17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18 \\$*
19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20 ..
21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" SH-xref - format a cross-reference to an SH section
23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 .de SH-xref
25 .ie n \{\
26 .\}
27 .toupper \\$*
28 .el \{\
29 \\$*
30 .\}
31 ..
32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 .\" SH - level-one heading that works better for non-TTY output
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35 .de1 SH
36 .\" put an extra blank line of space above the head in non-TTY output
37 .if t \{\
38 .sp 1
39 .\}
40 .sp \\n[PD]u
41 .nr an-level 1
42 .set-an-margin
43 .nr an-prevailing-indent \\n[IN]
44 .fi
45 .in \\n[an-margin]u
46 .ti 0
47 .HTML-TAG ".NH \\n[an-level]"
48 .it 1 an-trap
49 .nr an-no-space-flag 1
50 .nr an-break-flag 1
51 \." make the size of the head bigger
52 .ps +3
53 .ft B
54 .ne (2v + 1u)
55 .ie n \{\
56 .\" if n (TTY output), use uppercase
57 .toupper \\$*
58 .\}
59 .el \{\
60 .nr an-break-flag 0
61 .\" if not n (not TTY), use normal case (not uppercase)
62 \\$1
63 .in \\n[an-margin]u
64 .ti 0
65 .\" if not n (not TTY), put a border/line under subheading
66 .sp -.6
67 \l'\n(.lu'
68 .\}
69 ..
70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 .\" SS - level-two heading that works better for non-TTY output
72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73 .de1 SS
74 .sp \\n[PD]u
75 .nr an-level 1
76 .set-an-margin
77 .nr an-prevailing-indent \\n[IN]
78 .fi
79 .in \\n[IN]u
80 .ti \\n[SN]u
81 .it 1 an-trap
82 .nr an-no-space-flag 1
83 .nr an-break-flag 1
84 .ps \\n[PS-SS]u
85 \." make the size of the head bigger
86 .ps +2
87 .ft B
88 .ne (2v + 1u)
89 .if \\n[.$] \&\\$*
90 ..
91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 .\" BB/BE - put background/screen (filled box) around block of text
93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94 .de BB
95 .if t \{\
96 .sp -.5
97 .br
98 .in +2n
99 .ll -2n
100 .gcolor red
101 .di BX
102 .\}
103 ..
104 .de EB
105 .if t \{\
106 .if "\\$2"adjust-for-leading-newline" \{\
107 .sp -1
108 .\}
109 .br
110 .di
111 .in
112 .ll
113 .gcolor
114 .nr BW \\n(.lu-\\n(.i
115 .nr BH \\n(dn+.5v
116 .ne \\n(BHu+.5v
117 .ie "\\$2"adjust-for-leading-newline" \{\
118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119 .\}
120 .el \{\
121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122 .\}
123 .in 0
124 .sp -.5v
125 .nf
126 .BX
127 .in
128 .sp .5v
129 .fi
130 .\}
131 ..
132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 .\" BM/EM - put colored marker in margin next to block of text
134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135 .de BM
136 .if t \{\
137 .br
138 .ll -2n
139 .gcolor red
140 .di BX
141 .\}
142 ..
143 .de EM
144 .if t \{\
145 .br
146 .di
147 .ll
148 .gcolor
149 .nr BH \\n(dn
150 .ne \\n(BHu
151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152 .in 0
153 .nf
154 .BX
155 .in
156 .fi
157 .\}
158 ..
159 .\" -----------------------------------------------------------------
160 .\" * set default formatting
161 .\" -----------------------------------------------------------------
162 .\" disable hyphenation
163 .nh
164 .\" disable justification (adjust text to left margin only)
165 .ad l
166 .\" -----------------------------------------------------------------
167 .\" * MAIN CONTENT STARTS HERE *
168 .\" -----------------------------------------------------------------
169 .SH "Name"
170 amanda \- The Open Source Backup Platform
171 .SH "DESCRIPTION"
172 .PP
173 This manual page gives an overview of the
174 \fIAmanda\fR
175 commands and configuration files for quick reference\&.
176 .SS "COMMANDS"
177 .PP
178 Here are all the
179 \fIAmanda\fR
180 commands\&. Each one has its own manual page\&. See them for all the gory details\&.
181 .sp
182 .RS 4
183 .ie n \{\
184 \h'-04'\(bu\h'+03'\c
185 .\}
186 .el \{\
187 .sp -1
188 .IP \(bu 2.3
189 .\}
190 \fBamaddclient\fR(8),
191 .RE
192 .sp
193 .RS 4
194 .ie n \{\
195 \h'-04'\(bu\h'+03'\c
196 .\}
197 .el \{\
198 .sp -1
199 .IP \(bu 2.3
200 .\}
201 \fBamadmin\fR(8),
202 .RE
203 .sp
204 .RS 4
205 .ie n \{\
206 \h'-04'\(bu\h'+03'\c
207 .\}
208 .el \{\
209 .sp -1
210 .IP \(bu 2.3
211 .\}
212 \fBamaespipe\fR(8),
213 .RE
214 .sp
215 .RS 4
216 .ie n \{\
217 \h'-04'\(bu\h'+03'\c
218 .\}
219 .el \{\
220 .sp -1
221 .IP \(bu 2.3
222 .\}
223 \fBamcheck\fR(8),
224 .RE
225 .sp
226 .RS 4
227 .ie n \{\
228 \h'-04'\(bu\h'+03'\c
229 .\}
230 .el \{\
231 .sp -1
232 .IP \(bu 2.3
233 .\}
234 \fBamcheckdb\fR(8),
235 .RE
236 .sp
237 .RS 4
238 .ie n \{\
239 \h'-04'\(bu\h'+03'\c
240 .\}
241 .el \{\
242 .sp -1
243 .IP \(bu 2.3
244 .\}
245 \fBamcheckdump\fR(8),
246 .RE
247 .sp
248 .RS 4
249 .ie n \{\
250 \h'-04'\(bu\h'+03'\c
251 .\}
252 .el \{\
253 .sp -1
254 .IP \(bu 2.3
255 .\}
256 \fBamcleanup\fR(8),
257 .RE
258 .sp
259 .RS 4
260 .ie n \{\
261 \h'-04'\(bu\h'+03'\c
262 .\}
263 .el \{\
264 .sp -1
265 .IP \(bu 2.3
266 .\}
267 \fBamcrypt-ossl-asym\fR(8),
268 .RE
269 .sp
270 .RS 4
271 .ie n \{\
272 \h'-04'\(bu\h'+03'\c
273 .\}
274 .el \{\
275 .sp -1
276 .IP \(bu 2.3
277 .\}
278 \fBamcrypt-ossl\fR(8),
279 .RE
280 .sp
281 .RS 4
282 .ie n \{\
283 \h'-04'\(bu\h'+03'\c
284 .\}
285 .el \{\
286 .sp -1
287 .IP \(bu 2.3
288 .\}
289 \fBamcrypt\fR(8),
290 .RE
291 .sp
292 .RS 4
293 .ie n \{\
294 \h'-04'\(bu\h'+03'\c
295 .\}
296 .el \{\
297 .sp -1
298 .IP \(bu 2.3
299 .\}
300 \fBamcryptsimple\fR(8),
301 .RE
302 .sp
303 .RS 4
304 .ie n \{\
305 \h'-04'\(bu\h'+03'\c
306 .\}
307 .el \{\
308 .sp -1
309 .IP \(bu 2.3
310 .\}
311 \fBamdd\fR(8),
312 .RE
313 .sp
314 .RS 4
315 .ie n \{\
316 \h'-04'\(bu\h'+03'\c
317 .\}
318 .el \{\
319 .sp -1
320 .IP \(bu 2.3
321 .\}
322 \fBamdevcheck\fR(8),
323 .RE
324 .sp
325 .RS 4
326 .ie n \{\
327 \h'-04'\(bu\h'+03'\c
328 .\}
329 .el \{\
330 .sp -1
331 .IP \(bu 2.3
332 .\}
333 \fBamdump\fR(8),
334 .RE
335 .sp
336 .RS 4
337 .ie n \{\
338 \h'-04'\(bu\h'+03'\c
339 .\}
340 .el \{\
341 .sp -1
342 .IP \(bu 2.3
343 .\}
344 \fBamfetchdump\fR(8),
345 .RE
346 .sp
347 .RS 4
348 .ie n \{\
349 \h'-04'\(bu\h'+03'\c
350 .\}
351 .el \{\
352 .sp -1
353 .IP \(bu 2.3
354 .\}
355 \fBamflush\fR(8),
356 .RE
357 .sp
358 .RS 4
359 .ie n \{\
360 \h'-04'\(bu\h'+03'\c
361 .\}
362 .el \{\
363 .sp -1
364 .IP \(bu 2.3
365 .\}
366 \fBamgetconf\fR(8),
367 .RE
368 .sp
369 .RS 4
370 .ie n \{\
371 \h'-04'\(bu\h'+03'\c
372 .\}
373 .el \{\
374 .sp -1
375 .IP \(bu 2.3
376 .\}
377 \fBamgpgcrypt\fR(8),
378 .RE
379 .sp
380 .RS 4
381 .ie n \{\
382 \h'-04'\(bu\h'+03'\c
383 .\}
384 .el \{\
385 .sp -1
386 .IP \(bu 2.3
387 .\}
388 \fBamgtar\fR(8),
389 .RE
390 .sp
391 .RS 4
392 .ie n \{\
393 \h'-04'\(bu\h'+03'\c
394 .\}
395 .el \{\
396 .sp -1
397 .IP \(bu 2.3
398 .\}
399 \fBamlabel\fR(8),
400 .RE
401 .sp
402 .RS 4
403 .ie n \{\
404 \h'-04'\(bu\h'+03'\c
405 .\}
406 .el \{\
407 .sp -1
408 .IP \(bu 2.3
409 .\}
410 \fBammt\fR(8),
411 .RE
412 .sp
413 .RS 4
414 .ie n \{\
415 \h'-04'\(bu\h'+03'\c
416 .\}
417 .el \{\
418 .sp -1
419 .IP \(bu 2.3
420 .\}
421 \fBamoverview\fR(8),
422 .RE
423 .sp
424 .RS 4
425 .ie n \{\
426 \h'-04'\(bu\h'+03'\c
427 .\}
428 .el \{\
429 .sp -1
430 .IP \(bu 2.3
431 .\}
432 \fBamplot\fR(8),
433 .RE
434 .sp
435 .RS 4
436 .ie n \{\
437 \h'-04'\(bu\h'+03'\c
438 .\}
439 .el \{\
440 .sp -1
441 .IP \(bu 2.3
442 .\}
443 \fBamrecover\fR(8),
444 .RE
445 .sp
446 .RS 4
447 .ie n \{\
448 \h'-04'\(bu\h'+03'\c
449 .\}
450 .el \{\
451 .sp -1
452 .IP \(bu 2.3
453 .\}
454 \fBamreport\fR(8),
455 .RE
456 .sp
457 .RS 4
458 .ie n \{\
459 \h'-04'\(bu\h'+03'\c
460 .\}
461 .el \{\
462 .sp -1
463 .IP \(bu 2.3
464 .\}
465 \fBamrestore\fR(8),
466 .RE
467 .sp
468 .RS 4
469 .ie n \{\
470 \h'-04'\(bu\h'+03'\c
471 .\}
472 .el \{\
473 .sp -1
474 .IP \(bu 2.3
475 .\}
476 \fBamrmtape\fR(8),
477 .RE
478 .sp
479 .RS 4
480 .ie n \{\
481 \h'-04'\(bu\h'+03'\c
482 .\}
483 .el \{\
484 .sp -1
485 .IP \(bu 2.3
486 .\}
487 \fBamsamba\fR(8),
488 .RE
489 .sp
490 .RS 4
491 .ie n \{\
492 \h'-04'\(bu\h'+03'\c
493 .\}
494 .el \{\
495 .sp -1
496 .IP \(bu 2.3
497 .\}
498 \fBamserverconfig\fR(8),
499 .RE
500 .sp
501 .RS 4
502 .ie n \{\
503 \h'-04'\(bu\h'+03'\c
504 .\}
505 .el \{\
506 .sp -1
507 .IP \(bu 2.3
508 .\}
509 \fBamservice\fR(8),
510 .RE
511 .sp
512 .RS 4
513 .ie n \{\
514 \h'-04'\(bu\h'+03'\c
515 .\}
516 .el \{\
517 .sp -1
518 .IP \(bu 2.3
519 .\}
520 \fBamstar\fR(8),
521 .RE
522 .sp
523 .RS 4
524 .ie n \{\
525 \h'-04'\(bu\h'+03'\c
526 .\}
527 .el \{\
528 .sp -1
529 .IP \(bu 2.3
530 .\}
531 \fBamstatus\fR(8),
532 .RE
533 .sp
534 .RS 4
535 .ie n \{\
536 \h'-04'\(bu\h'+03'\c
537 .\}
538 .el \{\
539 .sp -1
540 .IP \(bu 2.3
541 .\}
542 \fBamtape\fR(8),
543 .RE
544 .sp
545 .RS 4
546 .ie n \{\
547 \h'-04'\(bu\h'+03'\c
548 .\}
549 .el \{\
550 .sp -1
551 .IP \(bu 2.3
552 .\}
553 \fBamtapetype\fR(8),
554 .RE
555 .sp
556 .RS 4
557 .ie n \{\
558 \h'-04'\(bu\h'+03'\c
559 .\}
560 .el \{\
561 .sp -1
562 .IP \(bu 2.3
563 .\}
564 \fBamtoc\fR(8),
565 .RE
566 .sp
567 .RS 4
568 .ie n \{\
569 \h'-04'\(bu\h'+03'\c
570 .\}
571 .el \{\
572 .sp -1
573 .IP \(bu 2.3
574 .\}
575 \fBamvault\fR(8),
576 .RE
577 .sp
578 .RS 4
579 .ie n \{\
580 \h'-04'\(bu\h'+03'\c
581 .\}
582 .el \{\
583 .sp -1
584 .IP \(bu 2.3
585 .\}
586 \fBamzfs-sendrecv\fR(8),
587 .RE
588 .sp
589 .RS 4
590 .ie n \{\
591 \h'-04'\(bu\h'+03'\c
592 .\}
593 .el \{\
594 .sp -1
595 .IP \(bu 2.3
596 .\}
597 \fBamzfs-snapshot\fR(8),
598 .RE
599 .sp
600 .RS 4
601 .ie n \{\
602 \h'-04'\(bu\h'+03'\c
603 .\}
604 .el \{\
605 .sp -1
606 .IP \(bu 2.3
607 .\}
608 \fBscript-email\fR(8),
609 .RE
610 .SS "CONFIGURATION FILES"
611 .sp
612 .RS 4
613 .ie n \{\
614 \h'-04'\(bu\h'+03'\c
615 .\}
616 .el \{\
617 .sp -1
618 .IP \(bu 2.3
619 .\}
620 \fBamanda.conf\fR(5),
621 .RE
622 .sp
623 .RS 4
624 .ie n \{\
625 \h'-04'\(bu\h'+03'\c
626 .\}
627 .el \{\
628 .sp -1
629 .IP \(bu 2.3
630 .\}
631 \fBamanda-client.conf\fR(5),
632 .RE
633 .sp
634 .RS 4
635 .ie n \{\
636 \h'-04'\(bu\h'+03'\c
637 .\}
638 .el \{\
639 .sp -1
640 .IP \(bu 2.3
641 .\}
642 \fBdisklist\fR(5),
643 .RE
644 .sp
645 .RS 4
646 .ie n \{\
647 \h'-04'\(bu\h'+03'\c
648 .\}
649 .el \{\
650 .sp -1
651 .IP \(bu 2.3
652 .\}
653 \fBtapelist\fR(5),
654 .RE
655 .SS "DATA FORMATS"
656 .sp
657 .RS 4
658 .ie n \{\
659 \h'-04'\(bu\h'+03'\c
660 .\}
661 .el \{\
662 .sp -1
663 .IP \(bu 2.3
664 .\}
665 \fBamanda-archive-format\fR(5),
666 .RE
667 .SS "CONCEPTS"
668 .sp
669 .RS 4
670 .ie n \{\
671 \h'-04'\(bu\h'+03'\c
672 .\}
673 .el \{\
674 .sp -1
675 .IP \(bu 2.3
676 .\}
677 \fBamanda-applications\fR(7),
678 .RE
679 .sp
680 .RS 4
681 .ie n \{\
682 \h'-04'\(bu\h'+03'\c
683 .\}
684 .el \{\
685 .sp -1
686 .IP \(bu 2.3
687 .\}
688 \fBamanda-auth\fR(7),
689 .RE
690 .sp
691 .RS 4
692 .ie n \{\
693 \h'-04'\(bu\h'+03'\c
694 .\}
695 .el \{\
696 .sp -1
697 .IP \(bu 2.3
698 .\}
699 \fBamanda-changers\fR(7),
700 .RE
701 .sp
702 .RS 4
703 .ie n \{\
704 \h'-04'\(bu\h'+03'\c
705 .\}
706 .el \{\
707 .sp -1
708 .IP \(bu 2.3
709 .\}
710 \fBamanda-devices\fR(7),
711 .RE
712 .sp
713 .RS 4
714 .ie n \{\
715 \h'-04'\(bu\h'+03'\c
716 .\}
717 .el \{\
718 .sp -1
719 .IP \(bu 2.3
720 .\}
721 \fBamanda-scripts\fR(7),
722 .RE
723 .SH "CONFIGURATION"
724 .PP
725 There are four user\-editable files that control the behavior of
726 \fIAmanda\fR\&.
727 .PP
728 The first two are
729 \fBamanda.conf\fR(5)
730 and
731 \fBamanda-client.conf\fR(5), the main configuration files for the server and client, respectively\&. They contain parameters to customize
732 \fIAmanda\fR
733 for the site\&.
734 .PP
735 Next is the
736 \fBdisklist\fR(5)
737 file, which lists hosts and disk partitions to back up\&.
738 .PP
739 Last is the seldom\-edited
740 \fBtapelist\fR(5)
741 file, which lists tapes that are currently active\&. These files are described in more detail in the following sections\&.
742 .PP
743 All files are stored in individual configuration directories, usually under
744 \FC/etc/amanda/\F[]\&. A site will often have more than one configuration\&. For example, it might have a
745 \fInormal\fR
746 configuration for everyday backups and an
747 \fIarchive\fR
748 configuration for infrequent full archival backups\&. The configuration files would be stored under directories
749 \FC/etc/amanda/normal/\F[]
750 and
751 \FC/etc/amanda/archive/\F[], respectively\&. Part of the job of an
752 \fIAmanda\fR
753 administrator is to create, populate and maintain these directories\&.
754 .SH "LOG FILES"
755 .PP
756 All log and database files generated by
757 \fIAmanda\fR
758 go in corresponding directories somewhere\&. The exact location is controlled by entries in
759 \fBamanda.conf\fR(5)\&. A typical location would be under
760 \FC/var/adm/amanda\F[]\&. For the above example, the files might go in
761 \FC/var/adm/amanda/normal/\F[]
762 and
763 \FC/var/adm/amanda/archive/\F[]\&.
764 .PP
765 As log files are no longer needed (no longer contain relevant information),
766 \fIAmanda\fR
767 cycles them out in various ways, depending on the type of file\&.
768 .PP
769 Detailed information about
770 \fBamdump\fR
771 runs are stored in dump logs \-\- files named
772 \fBamdump\&.\fR\fINN\fR
773 where
774 \fINN\fR
775 is a sequence number, with 1 being the most recent file\&.
776 \fBAmdump\fR
777 rotates these files each run, keeping roughly the last
778 \fBtapecycle\fR
779 (see below) worth of them\&.
780 .PP
781 The file used by
782 \fBamreport\fR
783 to generate the mail summary is the trace log\&. This file constitutes the "catalog" describing the data on the tapes written in a run\&. It is named
784 \fBlog\&.\fR\fIYYYYMMDDHHMMSS\&.NN\fR
785 where
786 \fIYYYYMMDDHHMMSS\fR
787 is the datestamp of the start of the
788 \fBamdump\fR
789 or
790 \fBamflush\fR
791 run and
792 \fINN\fR
793 is a sequence number started at 0\&. At the end of each
794 \fBamdump\fR
795 run, log files for runs whose tapes have been reused are renamed into a subdirectory of the main log directory (see the
796 \fBlogdir\fR
797 parameter below) named
798 \fBoldlog\fR\&. It is up to the
799 \fIAmanda\fR
800 administrator to remove them from this directory when desired\&.
801 .PP
802 Index (backup image catalogue) files older than the full dump matching the oldest backup image for a given client and disk are removed by
803 \fBamdump\fR
804 at the end of each run\&.
805 .SH "Using Samba"
806 .PP
807 For Samba access,
808 \fIAmanda\fR
809 needs a file on the Samba server (which may or may not also be the tape server) named
810 \FC/etc/amandapass\F[]
811 with share names, (clear text) passwords and (optional) domain names, in that order, one per line, whitespace separated\&. By default, the user used to connect to the PC is the same for all PC\'s and is compiled into
812 \fIAmanda\fR\&. It may be changed on a host by host basis by listing it first in the password field followed by a percent sign and then the password\&. For instance:
813 .nf
814   //some\-pc/home normalpw
815   //another\-pc/disk otheruser%otherpw
816 .fi
817 .PP
818 With clear text passwords, this file should obviously be tightly protected\&. It only needs to be readable by the
819 \fIAmanda\fR\-user on the Samba server\&.
820 .SH "HOST & DISK EXPRESSION"
821 .PP
822 All host and disk arguments to programs are special expressions\&. The command applies to all disks that match your arguments\&. This section describes the matcher\&.
823 .PP
824 The matcher matches by word, each word is a glob expression, words are separated by the separator \'\&.\' for host and \'/\' for disk\&. You can anchor the expression at left with a \'^\'\&. You can anchor the expression at right with a \'$\'\&. The matcher is case insensitive for host but is case sensitive for disk\&. A match succeeds if all words in your expression match contiguous words in the host or disk\&.
825 .PP
826 dot (\&.)
827 .RS 4
828 word separator for a host
829 .RE
830 .PP
831 /
832 .RS 4
833 word separator for a disk
834 .RE
835 .PP
836 ^
837 .RS 4
838 anchor at left
839 .RE
840 .PP
841 $
842 .RS 4
843 anchor at right
844 .RE
845 .PP
846 ?
847 .RS 4
848 match exactly one character except the separator
849 .RE
850 .PP
851 *
852 .RS 4
853 match zero or more characters except the separator
854 .RE
855 .PP
856 **
857 .RS 4
858 match zero or more characters including the separator
859 .RE
860 .PP
861 Some examples:
862 .PP
863 hosta
864 .RS 4
865 Will match
866 \FChosta\F[],
867 \FCfoo\&.hosta\&.org\F[], and
868 \FChoSTA\&.dOMAIna\&.ORG\F[]
869 but not
870 \FChostb\F[]\&.
871 .RE
872 .PP
873 host
874 .RS 4
875 Will match
876 \FChost\F[]
877 but not
878 \FChosta\F[]\&.
879 .RE
880 .PP
881 host?
882 .RS 4
883 Will match
884 \FChosta\F[]
885 and
886 \FChostb\F[], but not
887 \FChost\F[]\&.
888 .RE
889 .PP
890 ho*na
891 .RS 4
892 Will match
893 \FChoina\F[]
894 but not
895 \FCho\&.aina\&.org\F[]\&.
896 .RE
897 .PP
898 ho**na
899 .RS 4
900 Will match
901 \FChoina\F[]
902 and
903 \FCho\&.aina\&.org\F[]\&.
904 .RE
905 .PP
906 ^hosta
907 .RS 4
908 Will match
909 \FChosta\F[]
910 but not
911 \FCfoo\&.hosta\&.org\F[]\&.
912 .RE
913 .PP
914 sda*
915 .RS 4
916 Will match
917 \FC/dev/sda1\F[]
918 and
919 \FC/dev/sda12\F[]\&.
920 .RE
921 .PP
922 /opt
923 .RS 4
924 Will match the disk
925 \FCopt\F[]
926 but not the host
927 \FCopt\F[]\&.
928 .RE
929 .PP
930 (note dots:) \&.opt\&.
931 .RS 4
932 Will match the host
933 \FCopt\F[]
934 but not the disk
935 \FCopt\F[]\&.
936 .RE
937 .PP
938 /
939 .RS 4
940 Will match the disk
941 \FC/\F[]
942 but no other disk\&.
943 .RE
944 .PP
945 /usr
946 .RS 4
947 Will match the disks
948 \FC/usr\F[]
949 and
950 \FC/usr/local\F[]\&.
951 .RE
952 .PP
953 /usr$
954 .RS 4
955 Will match the disks
956 \FC/usr\F[]
957 but not
958 \FC/usr/local\F[]\&.
959 .RE
960 .SH "DATESTAMP EXPRESSION"
961 .PP
962 A
963 \fIdatestamp\fR
964 expression is a range expression where we only match the prefix\&. Leading ^ is removed\&. Trailing $ forces an exact match\&.
965 .PP
966 20001212\-14
967 .RS 4
968 match all dates beginning with 20001212, 20001213 or 20001214
969 .RE
970 .PP
971 20001212\-4
972 .RS 4
973 same as previous
974 .RE
975 .PP
976 20001212\-24
977 .RS 4
978 match all dates between 20001212 and 20001224
979 .RE
980 .PP
981 2000121
982 .RS 4
983 match all dates that start with 2000121 (20001210\-20001219)
984 .RE
985 .PP
986 2
987 .RS 4
988 match all dates that start with 2 (20000101\-29991231)
989 .RE
990 .PP
991 2000\-10
992 .RS 4
993 match all dates between 20000101\-20101231
994 .RE
995 .PP
996 200010$
997 .RS 4
998 match only 200010
999 .RE
1000 .SH "DUMP SPECIFICATIONS"
1001 .PP
1002 A dump specification selects one or more dumps\&. It has the form
1003 \fI[host][:disk][@datestamp]\fR, where each component is a pattern as described above\&. If a component is missing, it is treated as a wildcard\&. The characters \':\', \'@\', and \'\e\' may be escaped within any component by preceding them with a \'\e\'\&.
1004 .PP
1005 Some examples:
1006 .PP
1007 client17
1008 .RS 4
1009 all dumps of client17
1010 .RE
1011 .PP
1012 @20080615
1013 .RS 4
1014 All dumps on with datestamps matching 20080615
1015 .RE
1016 .PP
1017 webserver:/var/www
1018 .RS 4
1019 All dumps of /var/www on host webserver
1020 .RE
1021 .PP
1022 webserver:/var/www@200806150317
1023 .RS 4
1024 The dump of webserver with datestamp 200806150317
1025 .RE
1026 .PP
1027 :/var/www
1028 .RS 4
1029 All dumps of /var/www on any host
1030 .RE
1031 .SH "CONFIGURATION OVERRIDE"
1032 .PP
1033 Most commands allow the override of specific configuration options on the command line, using the
1034 \-o
1035 option\&. This option has the form
1036 \-o\fIname\fR=\fIvalue\fR\&. An optional space is allowed after the
1037 \-o\&. Each configuration option should be specified in a separate command\-line option\&.
1038 .PP
1039 For global options,
1040 \fIname\fR
1041 is simply the name of the option, e\&.g\&.,
1042 .sp
1043 .nf
1044 amdump \-oruntapes=2
1045 .fi
1046 For options in a named section of the configuration,
1047 \fIname\fR
1048 has the form
1049 \fISECTION\fR:\fIsection_name\fR:\fIname\fR, where
1050 \fISECTION\fR
1051 is one of TAPETYPE, DUMPTYPE, HOLDINGDISK, or INTERFACE, and
1052 \fIsection_name\fR
1053 is the name of the tapetype, dumptype, holdingdisk, or interface\&. Examples:
1054 .sp
1055 .nf
1056 amdump \-o TAPETYPE:HP\-DAT:length=2000m
1057 amdump \-o DUMPTYPE:no\-compress:compress="server fast"
1058 amdump \-o HOLDINGDISK:hd1:use="\-100 mb"
1059 amdump \-o INTERFACE:local:use="2000 kbps"
1060 .fi
1061 .PP
1062 When overriding device properties, one must carefully quote the command line to simulate the syntax of real configuration files\&. The following example should serve as a guide:
1063 .sp
1064 .nf
1065 amdump \-o \'device\-property="PROPERTY_MAX_VOLUME_USAGE" "100000"\'
1066 .fi
1067 .PP
1068 Note that configuration overrides are not effective for tape changers, which supply a tapedev based on their own configuration\&. In order to override
1069 \fItapedev\fR, you must also disable any changer:
1070 .sp
1071 .nf
1072 amdump \-otapedev=/dev/nst1 \-otpchanger=\'\'
1073 .fi
1074 .SH "Authors"
1075 .PP
1076 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
1077 .PP
1078 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>