Imported Upstream version 2.5.2p1

[debian/amanda] / docs / amgetconf.8.txt

diff --git a/docs/amgetconf.8.txt b/docs/amgetconf.8.txt
index 46a380558c819df9a74317f058f58b256b085733..af2093283d01041f149dfe2db3b87b1a2627229c 100644 (file)
--- a/docs/amgetconf.8.txt
+++ b/docs/amgetconf.8.txt
@@ -1,6 +1,6 @@
 
                              amgetconf
-Prev  Chapter 35. The AMANDA Manual Pages.  Next
+Prev  Chapter 36. The Amanda Manual Pages.  Next
 
 -------------------------------------------------------------------------------
 
@@ -10,11 +10,11 @@ amgetconf \14 look up amanda.conf variables
 
 Synopsis
 
-amgetconf [config] parameter
+amgetconf [config] [--list] parameter [ -o configoption]...
 
 DESCRIPTION
 
-Amgetconf looks up parameters in amanda.conf, the AMANDA configuration file, or
+Amgetconf looks up parameters in amanda.conf, the Amanda configuration file, or
 from the build and runtime environment, and returns their corresponding value.
 If config is not specified, amgetconf assumes it is being run from the
 configuration directory and that amanda.conf is present.
@@ -25,12 +25,54 @@ error and will return an empty string as the value. Flag variables (e.g.
 USE_AMANDAHOSTS) will return 1 if the flag is set or an empty string if it is
 not.
 If parameter begins with dbopen., the string following the period is a program
-name and an AMANDA debug file will be created for the caller. The name of the
+name and an Amanda debug file will be created for the caller. The name of the
 file is returned.
 If parameter begins with dbclose., the string following the period is a program
 name previously used with dbopen., followed by a colon (:) and the previously
 opened file name.
-See the amanda(8) man page for more details about AMANDA.
+See the amanda(8) man page for more details about Amanda.
+
+OPTIONS
+
+
+
+  --list
+      The parameter must be 'tapetype', 'dumptype, 'holdingdisk' or
+      'interface'. It will output, one by line, the list of identifier for the
+      parameter.
+
+
+        --list tapetype
+            Output the list of tapetype, one by line.
+
+        --list dumptype
+            Output the list of dumptype, one by line.
+
+        --list holdingdisk
+            Output the list of holdingdisk, one by line.
+
+        --list interface
+            Output the list of interface, one by line.
+
+
+  parameter
+      It could be one of the below format:
+
+
+        runtapes
+
+        DUMPTYPE:no-compress:compress
+
+        TAPETYPE:HP-DAT:length
+
+        INTERFACE:local:use
+
+        HOLDINGDISK:hd1:use
+
+
+  -o configoption
+      See the "CONFIGURATION OVERRIDE" section in amanda(8).
+
 
 EXAMPLE
 
@@ -58,8 +100,7 @@ MESSAGES
 
   amgetconf: no such parameter param
       Parameter param is not a known keyword (e.g. not a valid amanda.conf
-      keyword). In this case, amgetconf will write "BUGGY" to stdout as the
-      value.
+      keyword).
 
 
 SEE ALSO