Imported Upstream version 2.6.1
[debian/amanda] / man / amserverconfig.8
index 093899de8468648c792327a8d6cf27a10b22f4ab..2838d193d190a56b9cebf30501a5182db716e8a5 100644 (file)
 .\"     Title: amserverconfig
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\"      Date: 08/22/2008
-.\"    Manual: 
-.\"    Source: 
+.\"    Author: Kevin Till <kevin.till@zmanda.com>
+.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
+.\"      Date: 01/22/2009
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 2.6.1
+.\"  Language: English
 .\"
-.TH "AMSERVERCONFIG" "8" "08/22/2008" "" ""
+.TH "AMSERVERCONFIG" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * (re)Define some macros
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" toupper - uppercase a string (locale-aware)
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.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
+.\}
+..
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
-.SH "NAME"
-amserverconfig - program to setup initial Amanda configuration
-.SH "SYNOPSIS"
-.HP 15
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+amserverconfig \- program to setup initial \fIAmanda\fR configuration
+.SH "Synopsis"
+.fam C
+.HP \w'\fBamserverconfig\fR\ 'u
 \fBamserverconfig\fR \fIconfig\fR [\-\-template\ \fItemplate\fR] [\-\-no\-vtape] [\-\-tapetype\ \fItapetype\fR] [\-\-tpchanger\ \fItpchanger\fR] [\-\-tapedev\ \fItapedev\fR] [\-\-changerfile\ \fIchangerfile\fR] [\-\-changerdev\ \fIchangerdev\fR] [\-\-labelstr\ \fIlabelstr\fR] [\-\-mailto\ \fImailto\fR] [\-\-dumpcycle\ \fIdumpcycle\fR] [\-\-runspercycle\ \fIrunspercycle\fR] [\-\-runtapes\ \fIruntapes\fR] [\-\-tapecycle\ \fItapecycle\fR] [\-\-help]
+.fam
 .SH "DESCRIPTION"
 .PP
 After Amanda rpms are successfully installed,
 \fBamserverconfig\fR
 will setup initial
 \fIAmanda\fR
-configuration files\. It will create /var/lib/amanda/guntar\-lists directory if one does not exist\.
+configuration files\&. It will create /var/lib/amanda/guntar\-lists directory if one does not exist\&.
 \fBamserverconfig\fR
 does not change existing
 \fIAmanda\fR
-configurations\.
+configurations\&.
 \fBamserverconfig\fR
-must be run by user amandabackup\.
-.SH "OPTIONS"
+must be run by user amandabackup\&.
+.SH "Options"
 .PP
-Options may be abbreviated, as long as the abbreviation is not ambiguous\. Option argument can either separated by \'=\' or a space\. Example: \-\-templ=harddisk \-\-tapedev /dev/nst0
+Options may be abbreviated, as long as the abbreviation is not ambiguous\&. Option argument can either separated by \'=\' or a space\&. Example: \-\-templ=harddisk \-\-tapedev /dev/nst0
 .PP
 
 \fBamserverconfig\fR
 builds a new "config"
 \fIAmanda\fR
-configuration\. Customize the configuration with the options below\.
+configuration\&. Customize the configuration with the options below\&.
 .PP
 \fB\-\-template template\fR
 .RS 4
 build
 \fIAmanda\fR
-configuration with pre\-configured template files\. Currently,
+configuration with pre\-configured template files\&. Currently,
 \fBharddisk\fR,
 \fBsingle\-tape\fR,
 \fBtape\-changer\fR
 and
 \fBS3\fR
-are the valid inputs for this option\. Pre\-configured template files can be found in /var/lib/amanda/template\.d\. This option may be combined with other options\.
+are the valid inputs for this option\&. Pre\-configured template files can be found in /var/lib/amanda/template\&.d\&. This option may be combined with other options\&.
 .sp
-If tape\-changer is chosen for this option, program mtx is required\.
+If tape\-changer is chosen for this option, program mtx is required\&.
 \fBamserverconfig\fR
-will search for mtx in the following directory: "/usr/sbin", "/usr/local/sbin", "/usr/local/bin", "/usr/bin", "/bin" and amandabackup\'s PATH\.
+will search for mtx in the following directory: "/usr/sbin", "/usr/local/sbin", "/usr/local/bin", "/usr/bin", "/bin" and amandabackup\'s PATH\&.
 .sp
 If harddisk is chosen and \-\-no\-vtape is not specified,
 \fBamserverconfig\fR
-will create and label virtual tape file://var/lib/amanda/vtapes/$config\.
+will create and label virtual tape file://var/lib/amanda/vtapes/$config\&.
 .RE
 .PP
 \fB\-\-no\-vtape\fR
 .RS 4
-Do not create virtual tapes in the harddisk template case\.
+Do not create virtual tapes in the harddisk template case\&.
 .RE
 .PP
 \fB\-\-tapedev tapedev\fR
 .RS 4
-The path name of non\-rewinding tape device\. default [file://var/lib/amanda/vtapes/$config]
+The path name of non\-rewinding tape device\&. default [file://var/lib/amanda/vtapes/$config]
 .RE
 .PP
 \fB\-\-tpchanger tpchanger\fR
 .RS 4
-The name of the tape changer\. default [chg\-disk]
+The name of the tape changer\&. default [chg\-disk]
 .RE
 .PP
 \fB\-\-changerdev changerdev\fR
 .RS 4
-A tape changer configuration parameter\. default [/dev/null]
+A tape changer configuration parameter\&. default [/dev/null]
 .RE
 .PP
 \fB\-\-changerfile changerfile\fR
 .RS 4
-A tape changer configuration parameter\. default [/etc/amanda/$config/changer\.conf]
+A tape changer configuration parameter\&. default [/etc/amanda/$config/changer\&.conf]
 .RE
 .PP
 \fB\-\-labelstr labelstr\fR
 .RS 4
-The tape label constraint regular expression\. default [^$config\-[0\-9][0\-9]*$]
+The tape label constraint regular expression\&. default [^$config\-[0\-9][0\-9]*$]
 .sp
-If this option is used with \-\-template=harddisk, only alphanumeric string is supported\.
+If this option is used with \-\-template=harddisk, only alphanumeric string is supported\&.
 .RE
 .PP
 \fB\-\-tapetype tapetype\fR
 .RS 4
-The type of tape drive associated with tapedev or tpchanger\. default [HARDDISK]
+The type of tape drive associated with tapedev or tpchanger\&. default [HARDDISK]
 .RE
 .PP
 \fB\-\-mailto mailto\fR
 .RS 4
-A space separated list of recipients for mail reports\. default [amandabackup]
+A space separated list of recipients for mail reports\&. default [amandabackup]
 .RE
 .PP
 \fB\-\-dumpcycle dumpcycle\fR
 .RS 4
-The number of days in the backup cycle\. default [1week]
+The number of days in the backup cycle\&. default [1week]
 .RE
 .PP
 \fB\-\-runspercycle runspercycle\fR
 .RS 4
-The number of days in the backup cycle\. default [5]
+The number of days in the backup cycle\&. default [5]
 .RE
 .PP
 \fB\-\-runtapes runtapes\fR
 .RS 4
-The maximum number of tapes used in a single run\. default [1]
+The maximum number of tapes used in a single run\&. default [1]
 .RE
 .PP
 \fB\-\-tapecycle tapecycle\fR
 .RS 4
-The size of tape rotation\. default [25]
+The size of tape rotation\&. default [25]
 .RE
 .PP
 \fB\-\-help\fR
 .RS 4
-Display usage\.
+Display usage\&.
 .RE
-.SH "FILES"
+.SH "Files"
 .PP
-\fB/var/lib/amanda/template\.d\fR
+\fB/var/lib/amanda/template\&.d\fR
 .RS 4
 Amanda configuration template files install location
 .RE
@@ -139,43 +297,46 @@ amandabackup home directory
 .PP
 \fB/var/lib/amanda/gnutar\-lists\fR
 .RS 4
-A directory which contains backup timestamp and list of files backed up\.
+A directory which contains backup timestamp and list of files backed up\&.
 .RE
 .PP
 \fB/etc/amanda/$config\fR
 .RS 4
 \fIAmanda\fR
-configuration files location for $config(e\.g: DailySet1)\.
+configuration files location for $config(e\&.g: DailySet1)\&.
 .RE
 .PP
-\fB/etc/amanda/template\.d\fR
+\fB/etc/amanda/template\&.d\fR
 .RS 4
 A directory contains dumptypes and tapetypes files used by all
 \fIAmanda\fR
-configurations\.
+configurations\&.
 .RE
 .PP
 \fB/etc/amandates\fR
 .RS 4
 \fIAmanda\fR
-file on the client\. It keeps track of structures of previous dumps\.
+file on the client\&. It keeps track of structures of previous dumps\&.
 .RE
 .PP
 \fB/tmp/amanda\fR
 .RS 4
 directory contains
 \fIAmanda\fR
-debug log files\.
+debug log files\&.
 .RE
 .SH "RETURN VALUE"
 
-On success, zero is returned\.  On error, 1 is returned\.
-.SH "AUTHOR"
-.PP
-The tool and its documentation was written by Zmanda, Inc (http://www\.zmanda\.com/)\.
+On success, zero is returned\&.  On error, 1 is returned\&.
 .SH "SEE ALSO"
 .PP
 \fBamanda\fR(8),
 \fBamanda.conf\fR(5),
 \fBamaddclient\fR(8),
 : http://wiki.zmanda.com
+.SH "Author"
+.PP
+\fBKevin Till\fR <\&kevin\&.till@zmanda\&.com\&>
+.RS 4
+Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
+.RE