revert to upstream
[debian/amanda] / man / amgetconf.8
index 8fef610a059ec46db859fe596987b1ca92735634..753a845d050a3dee106cbfbff424246d841e0cb9 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 "" "" ""
-.SH NAME
-amgetconf \- look up amanda.conf variables
-.SH "SYNOPSIS"
+.\"     Title: amgetconf
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
+.\"      Date: 08/22/2008
+.\"    Manual: 
+.\"    Source: 
+.\"
+.TH "AMGETCONF" "8" "08/22/2008" "" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
 .ad l
-.hy 0
+.SH "NAME"
+amgetconf - look up amanda.conf variables
+.SH "SYNOPSIS"
 .HP 10
-\fBamgetconf\fR [\fIconfig\fR] \fIparameter\fR
-.ad
-.hy
-
+\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 configuration file, or from the build and runtime environment, and returns their corresponding value\&.
-
+\fBAmgetconf\fR
+looks up parameters in
+\fIamanda\.conf\fR, the
+\fIAmanda\fR
+configuration file, or from the build and runtime environment, and returns their corresponding value\.
 .PP
-If \fBconfig\fR is not specified, \fBamgetconf\fR assumes it is being run from the configuration directory and that \fBamanda\&.conf\fR is present\&.
-
+If
+\fIconfig\fR
+is not specified,
+\fBamgetconf\fR
+assumes it is being run from the configuration directory and that
+\fIamanda\.conf\fR
+is present\.
 .PP
-If \fBparameter\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 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 1 if the flag is set or an empty string if it is not\&.
-
+If
+\fIparameter\fR
+begins with
+\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\.
+\fIUSE_AMANDAHOSTS\fR) will return
+1
+if the flag is set or an empty string if it is not\.
 .PP
-If \fBparameter\fR begins with \fBdbopen\&.\fR, the string following the period is a program name and an \fBAmanda\fR debug file will be created for the caller\&. The name of the file is returned\&.
-
+If
+\fIparameter\fR
+begins with
+\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 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\&.
-
+If
+\fIparameter\fR
+begins with
+\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\&.
-
+See the
+\fBamanda\fR(8)
+man page for more details about
+\fIAmanda\fR\.
+.SH "OPTIONS"
+.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\.
+.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
+.PP
+\fBparameter\fR
+.RS 4
+It could be one of the below format:
+.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
+.PP
+\fB\-o\fR \fIconfigoption\fR
+.RS 4
+See the "\fBCONFIGURATION OVERRIDE\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
 .PP
 Find out the current tape type:
-
+.sp
+.RS 4
 .nf
-
 % amgetconf daily tapetype
 DLT4000\-IV
-
 .fi
-
+.RE
 .PP
 Find out the default configuration directory:
-
+.sp
+.RS 4
 .nf
-
-% amgetconf daily build\&.CONFIG_DIR
+% amgetconf daily build\.CONFIG_DIR
 /usr/local/etc/amanda/
-
 .fi
-
+.RE
 .PP
 Create, use and close a debug file in a script:
-
+.sp
+.RS 4
 .nf
-
-% set debug_file = `amgetconf daily dbopen\&.myscript`
+% set debug_file = `amgetconf daily dbopen\.myscript`
 % echo debug information >> $debug_file
-% amgetconf daily dbclose\&.myscript:$debug_file
-
+% amgetconf daily dbclose\.myscript:$debug_file
 .fi
-
+.RE
+.sp
 .SH "MESSAGES"
-
-.TP
-amgetconf: no such parameter \fBparam\fR
-Parameter \fBparam\fR is not a known keyword (e\&.g\&. not a valid \fBamanda\&.conf\fR keyword)\&. In this case, \fBamgetconf\fR will write "\fBBUGGY\fR" to stdout as the value\&.
-
+.PP
+amgetconf: no such parameter \fIparam\fR
+.RS 4
+Parameter
+\fIparam\fR
+is not a known keyword (e\.g\. not a valid
+\fIamanda\.conf\fR
+keyword)\.
+.RE
 .SH "SEE ALSO"
-
 .PP
-\fBamanda\fR(8)
 
+\fBamanda\fR(8),
+: http://wiki.zmanda.com