X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famanda.8;h=a0fac58d13ec9883fdb36e9c455bfcc61a2321d8;hb=0ab9787cd7de76aad522ee8d55ed7e87e3047458;hp=be00f849317312aa9e36b16d2f99f413cf2fb285;hpb=afaa71b3866b46b082b6c895772e15b36d8865fe;p=debian%2Famanda diff --git a/man/amanda.8 b/man/amanda.8 index be00f84..a0fac58 100644 --- a/man/amanda.8 +++ b/man/amanda.8 @@ -1,161 +1,22 @@ +'\" t .\" Title: amanda .\" Author: James da Silva -.\" Generator: DocBook XSL Stylesheets v1.74.0 -.\" Date: 01/22/2009 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 02/21/2012 .\" Manual: System Administration Commands -.\" Source: Amanda 2.6.1 +.\" Source: Amanda 3.3.1 .\" Language: English .\" -.TH "AMANDA" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands" +.TH "AMANDA" "8" "02/21/2012" "Amanda 3\&.3\&.1" "System Administration Commands" .\" ----------------------------------------------------------------- -.\" * (re)Define some macros +.\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" toupper - uppercase a string (locale-aware) +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de toupper -.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ -\\$* -.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SH-xref - format a cross-reference to an SH section -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de SH-xref -.ie n \{\ -.\} -.toupper \\$* -.el \{\ -\\$* -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SH - level-one heading that works better for non-TTY output -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de1 SH -.\" put an extra blank line of space above the head in non-TTY output -.if t \{\ -.sp 1 -.\} -.sp \\n[PD]u -.nr an-level 1 -.set-an-margin -.nr an-prevailing-indent \\n[IN] -.fi -.in \\n[an-margin]u -.ti 0 -.HTML-TAG ".NH \\n[an-level]" -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -\." make the size of the head bigger -.ps +3 -.ft B -.ne (2v + 1u) -.ie n \{\ -.\" if n (TTY output), use uppercase -.toupper \\$* -.\} -.el \{\ -.nr an-break-flag 0 -.\" if not n (not TTY), use normal case (not uppercase) -\\$1 -.in \\n[an-margin]u -.ti 0 -.\" if not n (not TTY), put a border/line under subheading -.sp -.6 -\l'\n(.lu' -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SS - level-two heading that works better for non-TTY output -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de1 SS -.sp \\n[PD]u -.nr an-level 1 -.set-an-margin -.nr an-prevailing-indent \\n[IN] -.fi -.in \\n[IN]u -.ti \\n[SN]u -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.ps \\n[PS-SS]u -\." make the size of the head bigger -.ps +2 -.ft B -.ne (2v + 1u) -.if \\n[.$] \&\\$* -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BB/BE - put background/screen (filled box) around block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BB -.if t \{\ -.sp -.5 -.br -.in +2n -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EB -.if t \{\ -.if "\\$2"adjust-for-leading-newline" \{\ -.sp -1 -.\} -.br -.di -.in -.ll -.gcolor -.nr BW \\n(.lu-\\n(.i -.nr BH \\n(dn+.5v -.ne \\n(BHu+.5v -.ie "\\$2"adjust-for-leading-newline" \{\ -\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] -.\} -.el \{\ -\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] -.\} -.in 0 -.sp -.5v -.nf -.BX -.in -.sp .5v -.fi -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BM/EM - put colored marker in margin next to block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BM -.if t \{\ -.br -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EM -.if t \{\ -.br -.di -.ll -.gcolor -.nr BH \\n(dn -.ne \\n(BHu -\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] -.in 0 -.nf -.BX -.in -.fi -.\} -.. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -166,18 +27,14 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- -.SH "Name" +.SH "NAME" amanda \- The Open Source Backup Platform .SH "DESCRIPTION" .PP -This manual page gives an overview of the -\fIAmanda\fR -commands and configuration files for quick reference\&. +This manual page gives an overview of the Amanda commands and configuration files for quick reference\&. .SS "COMMANDS" .PP -Here are all the -\fIAmanda\fR -commands\&. Each one has its own manual page\&. See them for all the gory details\&. +Here are all the Amanda commands\&. Each one has its own manual page\&. See them for all the gory details\&. .sp .RS 4 .ie n \{\ @@ -220,7 +77,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} -\fBamcheck\fR(8), +\fBamarchiver\fR(8), .RE .sp .RS 4 @@ -231,7 +88,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} -\fBamcheckdb\fR(8), +\fBamcheck\fR(8), .RE .sp .RS 4 @@ -242,7 +99,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} -\fBamcheckdump\fR(8), +\fBamcheckdb\fR(8), .RE .sp .RS 4 @@ -253,7 +110,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} -\fBamcleanup\fR(8), +\fBamcheckdump\fR(8), .RE .sp .RS 4 @@ -264,7 +121,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} -\fBamcrypt-ossl-asym\fR(8), +\fBamcleanup\fR(8), .RE .sp .RS 4 @@ -275,7 +132,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} -\fBamcrypt-ossl\fR(8), +\fBamcrypt-ossl-asym\fR(8), .RE .sp .RS 4 @@ -286,7 +143,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} -\fBamcrypt\fR(8), +\fBamcrypt-ossl\fR(8), .RE .sp .RS 4 @@ -297,7 +154,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} -\fBamcryptsimple\fR(8), +\fBamcrypt\fR(8), .RE .sp .RS 4 @@ -308,7 +165,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} -\fBamdd\fR(8), +\fBamcryptsimple\fR(8), .RE .sp .RS 4 @@ -407,7 +264,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} -\fBammt\fR(8), +\fBamoverview\fR(8), .RE .sp .RS 4 @@ -418,7 +275,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} -\fBamoverview\fR(8), +\fBampgsql\fR(8), .RE .sp .RS 4 @@ -440,6 +297,17 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} +\fBamraw\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} \fBamrecover\fR(8), .RE .sp @@ -539,6 +407,17 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} +\fBamsuntar\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} \fBamtape\fR(8), .RE .sp @@ -707,6 +586,17 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} +\fBamanda-compatibility\fR(7), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} \fBamanda-devices\fR(7), .RE .sp @@ -718,19 +608,49 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail .sp -1 .IP \(bu 2.3 .\} +\fBamanda-interactivity\fR(7), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamanda-match\fR(7), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} \fBamanda-scripts\fR(7), .RE -.SH "CONFIGURATION" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamanda-taperscan\fR(7), +.RE +.SH "CONFIGURATION FILES" .PP -There are four user\-editable files that control the behavior of -\fIAmanda\fR\&. +There are four user\-editable files that control the behavior of Amanda\&. .PP The first two are \fBamanda.conf\fR(5) and -\fBamanda-client.conf\fR(5), the main configuration files for the server and client, respectively\&. They contain parameters to customize -\fIAmanda\fR -for the site\&. +\fBamanda-client.conf\fR(5), the main configuration files for the server and client, respectively\&. They contain parameters to customize Amanda for the site\&. .PP Next is the \fBdisklist\fR(5) @@ -740,295 +660,21 @@ Last is the seldom\-edited \fBtapelist\fR(5) file, which lists tapes that are currently active\&. These files are described in more detail in the following sections\&. .PP -All files are stored in individual configuration directories, usually under -\FC/etc/amanda/\F[]\&. A site will often have more than one configuration\&. For example, it might have a +All configuration files are stored in individual configuration directories, usually under +/etc/amanda/\&. A site will often have more than one configuration\&. For example, it might have a \fInormal\fR configuration for everyday backups and an \fIarchive\fR configuration for infrequent full archival backups\&. The configuration files would be stored under directories -\FC/etc/amanda/normal/\F[] -and -\FC/etc/amanda/archive/\F[], respectively\&. Part of the job of an -\fIAmanda\fR -administrator is to create, populate and maintain these directories\&. -.SH "LOG FILES" -.PP -All log and database files generated by -\fIAmanda\fR -go in corresponding directories somewhere\&. The exact location is controlled by entries in -\fBamanda.conf\fR(5)\&. A typical location would be under -\FC/var/adm/amanda\F[]\&. For the above example, the files might go in -\FC/var/adm/amanda/normal/\F[] +/etc/amanda/normal/ and -\FC/var/adm/amanda/archive/\F[]\&. +/etc/amanda/archive/, respectively\&. Part of the job of an Amanda administrator is to create, populate and maintain these directories\&. .PP -As log files are no longer needed (no longer contain relevant information), -\fIAmanda\fR -cycles them out in various ways, depending on the type of file\&. -.PP -Detailed information about -\fBamdump\fR -runs are stored in dump logs \-\- files named -\fBamdump\&.\fR\fINN\fR -where -\fINN\fR -is a sequence number, with 1 being the most recent file\&. -\fBAmdump\fR -rotates these files each run, keeping roughly the last -\fBtapecycle\fR -(see below) worth of them\&. -.PP -The file used by -\fBamreport\fR -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 -\fBlog\&.\fR\fIYYYYMMDDHHMMSS\&.NN\fR -where -\fIYYYYMMDDHHMMSS\fR -is the datestamp of the start of the -\fBamdump\fR -or -\fBamflush\fR -run and -\fINN\fR -is a sequence number started at 0\&. At the end of each -\fBamdump\fR -run, log files for runs whose tapes have been reused are renamed into a subdirectory of the main log directory (see the -\fBlogdir\fR -parameter below) named -\fBoldlog\fR\&. It is up to the -\fIAmanda\fR -administrator to remove them from this directory when desired\&. -.PP -Index (backup image catalogue) files older than the full dump matching the oldest backup image for a given client and disk are removed by -\fBamdump\fR -at the end of each run\&. -.SH "Using Samba" -.PP -For Samba access, -\fIAmanda\fR -needs a file on the Samba server (which may or may not also be the tape server) named -\FC/etc/amandapass\F[] -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 -\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: -.nf - //some\-pc/home normalpw - //another\-pc/disk otheruser%otherpw -.fi -.PP -With clear text passwords, this file should obviously be tightly protected\&. It only needs to be readable by the -\fIAmanda\fR\-user on the Samba server\&. -.SH "HOST & DISK EXPRESSION" -.PP -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\&. -.PP -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\&. -.PP -dot (\&.) -.RS 4 -word separator for a host -.RE -.PP -/ -.RS 4 -word separator for a disk -.RE -.PP -^ -.RS 4 -anchor at left -.RE -.PP -$ -.RS 4 -anchor at right -.RE -.PP -? -.RS 4 -match exactly one character except the separator -.RE -.PP -* -.RS 4 -match zero or more characters except the separator -.RE -.PP -** -.RS 4 -match zero or more characters including the separator -.RE -.PP -Some examples: -.PP -hosta -.RS 4 -Will match -\FChosta\F[], -\FCfoo\&.hosta\&.org\F[], and -\FChoSTA\&.dOMAIna\&.ORG\F[] -but not -\FChostb\F[]\&. -.RE -.PP -host -.RS 4 -Will match -\FChost\F[] -but not -\FChosta\F[]\&. -.RE -.PP -host? -.RS 4 -Will match -\FChosta\F[] -and -\FChostb\F[], but not -\FChost\F[]\&. -.RE -.PP -ho*na -.RS 4 -Will match -\FChoina\F[] -but not -\FCho\&.aina\&.org\F[]\&. -.RE -.PP -ho**na -.RS 4 -Will match -\FChoina\F[] -and -\FCho\&.aina\&.org\F[]\&. -.RE -.PP -^hosta -.RS 4 -Will match -\FChosta\F[] -but not -\FCfoo\&.hosta\&.org\F[]\&. -.RE -.PP -sda* -.RS 4 -Will match -\FC/dev/sda1\F[] -and -\FC/dev/sda12\F[]\&. -.RE -.PP -/opt -.RS 4 -Will match the disk -\FCopt\F[] -but not the host -\FCopt\F[]\&. -.RE -.PP -(note dots:) \&.opt\&. -.RS 4 -Will match the host -\FCopt\F[] -but not the disk -\FCopt\F[]\&. -.RE -.PP -/ -.RS 4 -Will match the disk -\FC/\F[] -but no other disk\&. -.RE -.PP -/usr -.RS 4 -Will match the disks -\FC/usr\F[] -and -\FC/usr/local\F[]\&. -.RE -.PP -/usr$ -.RS 4 -Will match the disks -\FC/usr\F[] -but not -\FC/usr/local\F[]\&. -.RE -.SH "DATESTAMP EXPRESSION" -.PP -A -\fIdatestamp\fR -expression is a range expression where we only match the prefix\&. Leading ^ is removed\&. Trailing $ forces an exact match\&. -.PP -20001212\-14 -.RS 4 -match all dates beginning with 20001212, 20001213 or 20001214 -.RE -.PP -20001212\-4 -.RS 4 -same as previous -.RE -.PP -20001212\-24 -.RS 4 -match all dates between 20001212 and 20001224 -.RE -.PP -2000121 -.RS 4 -match all dates that start with 2000121 (20001210\-20001219) -.RE -.PP -2 -.RS 4 -match all dates that start with 2 (20000101\-29991231) -.RE -.PP -2000\-10 -.RS 4 -match all dates between 20000101\-20101231 -.RE -.PP -200010$ -.RS 4 -match only 200010 -.RE -.SH "DUMP SPECIFICATIONS" -.PP -A dump specification selects one or more dumps\&. It has the form -\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\'\&. -.PP -Some examples: -.PP -client17 -.RS 4 -all dumps of client17 -.RE -.PP -@20080615 -.RS 4 -All dumps on with datestamps matching 20080615 -.RE -.PP -webserver:/var/www -.RS 4 -All dumps of /var/www on host webserver -.RE -.PP -webserver:/var/www@200806150317 -.RS 4 -The dump of webserver with datestamp 200806150317 -.RE -.PP -:/var/www -.RS 4 -All dumps of /var/www on any host -.RE -.SH "CONFIGURATION OVERRIDE" +Most Amanda applications take a "config" parameter; this is generally the (unqualified) name of the configuration directory, e\&.g\&., +normal\&. If the parameter is +\&. +(dot), the current directory is used\&. This feature is present for backward compatibility, but is not commonly used\&. +.SS "Configuration Override" .PP Most commands allow the override of specific configuration options on the command line, using the \-o @@ -1062,16 +708,16 @@ amdump \-o INTERFACE:local:use="2000 kbps" 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: .sp .nf -amdump \-o \'device\-property="PROPERTY_MAX_VOLUME_USAGE" "100000"\' +amdump \-o \*(Aqdevice\-property="PROPERTY_MAX_VOLUME_USAGE" "100000"\*(Aq .fi .PP Note that configuration overrides are not effective for tape changers, which supply a tapedev based on their own configuration\&. In order to override \fItapedev\fR, you must also disable any changer: .sp .nf -amdump \-otapedev=/dev/nst1 \-otpchanger=\'\' +amdump \-otapedev=/dev/nst1 \-otpchanger=\*(Aq\*(Aq .fi -.SH "Authors" +.SH "AUTHORS" .PP \fBJames da Silva\fR <\&jds@amanda\&.org\&> .PP