Imported Upstream version 2.5.1p3
[debian/amanda] / man / amgetconf.8
index bf0d35c503d7355316db6d32adbe38a8c2db7ed9..a8f8217913e85256cf3a02cacda4096795be2841 100644 (file)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "AMGETCONF" 8 "" "" ""
+.\"     Title: amgetconf
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
+.\"      Date: 02/07/2007
+.\"    Manual: 
+.\"    Source: 
+.\"
+.TH "AMGETCONF" "8" "02/07/2007" "" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
 .SH "NAME"
-amgetconf - look up amanda.conf variables
+amgetconf \- look up amanda.conf variables
 .SH "SYNOPSIS"
 .HP 10
-\fBamgetconf\fR [\fIconfig\fR] \fIparameter\fR [-o \fIconfigoption\fR]*
-
+\fBamgetconf\fR [\fIconfig\fR] [\fI\-\-list\fR] \fIparameter\fR [\-o\ \fIconfigoption\fR]...
 .SH "DESCRIPTION"
 .PP
 \fBAmgetconf\fR
 looks up parameters in
-\fBamanda.conf\fR, the
-\fBAmanda\fR
+\fIamanda.conf\fR, the
+\fIAmanda\fR
 configuration file, or from the build and runtime environment, and returns their corresponding value.
 .PP
 If
-\fBconfig\fR
+\fIconfig\fR
 is not specified,
 \fBamgetconf\fR
 assumes it is being run from the configuration directory and that
-\fBamanda.conf\fR
+\fIamanda.conf\fR
 is present.
 .PP
 If
-\fBparameter\fR
+\fIparameter\fR
 begins with
-\fBbuild.\fR, the (case insensitive) string following the period is a build environment variable. Variables without a value (e.g.
-\fBXFSDUMP\fR
+\fIbuild.\fR, the (case insensitive) string following the period is a build environment variable. Variables without a value (e.g.
+\fIXFSDUMP\fR
 on a system that does not support that type of file system) will not report an error and will return an empty string as the value. Flag variables (e.g.
-\fBUSE_AMANDAHOSTS\fR) will return
+\fIUSE_AMANDAHOSTS\fR) will return
 1
 if the flag is set or an empty string if it is not.
 .PP
 If
-\fBparameter\fR
+\fIparameter\fR
 begins with
-\fBdbopen.\fR, the string following the period is a program name and an
-\fBAmanda\fR
+\fIdbopen.\fR, the string following the period is a program name and an
+\fIAmanda\fR
 debug file will be created for the caller. The name of the file is returned.
 .PP
 If
-\fBparameter\fR
+\fIparameter\fR
 begins with
-\fBdbclose.\fR, the string following the period is a program name previously used with
-\fBdbopen.\fR, followed by a colon (:) and the previously opened file name.
+\fIdbclose.\fR, the string following the period is a program name previously used with
+\fIdbopen.\fR, followed by a colon (:) and the previously opened file name.
 .PP
 See the
 \fBamanda\fR(8)
 man page for more details about
-\fBAmanda\fR.
+\fIAmanda\fR.
 .SH "OPTIONS"
-.TP
-\fB-o\fR \fIconfigoption\fR
+.PP
+\fB\-\-list\fR
+.RS 4
+The parameter must be 'tapetype', 'dumptype, 'holdingdisk' or 'interface'. It will output, one by line, the list of identifier for the parameter.
+.RS 4
+.PP
+\-\-list tapetype
+.RS 4
+Output the list of tapetype, one by line.
+.RE
+.PP
+\-\-list dumptype
+.RS 4
+Output the list of dumptype, one by line.
+.RE
+.PP
+\-\-list holdingdisk
+.RS 4
+Output the list of holdingdisk, one by line.
+.RE
+.PP
+\-\-list interface
+.RS 4
+Output the list of interface, one by line.
+.RE
+.RE
+.RE
+.PP
+\fBparameter\fR
+.RS 4
+It could be one of the below format:
+.RS 4
+.PP
+runtapes
+.RS 4
+.RE
+.PP
+DUMPTYPE:no\-compress:compress
+.RS 4
+.RE
+.PP
+TAPETYPE:HP\-DAT:length
+.RS 4
+.RE
+.PP
+INTERFACE:local:use
+.RS 4
+.RE
+.PP
+HOLDINGDISK:hd1:use
+.RS 4
+.RE
+.RE
+.RE
+.PP
+\fB\-o\fR \fIconfigoption\fR
+.RS 4
 See the "\fBCONFIGURATION OVERWRITE\fR" section in
 \fBamanda\fR(8).
+.RE
 .SH "EXAMPLE"
 .PP
 Find out the path to the log file directory:
 .sp
+.RS 4
 .nf
-
 % amgetconf daily logdir
 /usr/local/etc/amanda//daily
-
 .fi
+.RE
 .sp
 .PP
 Find out the current tape type:
 .sp
+.RS 4
 .nf
-
 % amgetconf daily tapetype
-DLT4000-IV
-
+DLT4000\-IV
 .fi
+.RE
 .sp
 .PP
 Find out the default configuration directory:
 .sp
+.RS 4
 .nf
-
 % amgetconf daily build.CONFIG_DIR
 /usr/local/etc/amanda/
-
 .fi
+.RE
 .sp
 .PP
 Create, use and close a debug file in a script:
 .sp
+.RS 4
 .nf
-
 % set debug_file = `amgetconf daily dbopen.myscript`
 % echo debug information >> $debug_file
 % amgetconf daily dbclose.myscript:$debug_file
-
 .fi
+.RE
 .sp
 .SH "MESSAGES"
-.TP
-amgetconf: no such parameter \fBparam\fR
+.PP
+amgetconf: no such parameter \fIparam\fR
+.RS 4
 Parameter
-\fBparam\fR
+\fIparam\fR
 is not a known keyword (e.g. not a valid
-\fBamanda.conf\fR
+\fIamanda.conf\fR
 keyword).
+.RE
 .SH "SEE ALSO"
 .PP
 \fBamanda\fR(8)
-