Merge tag 'upstream/3.3.3'

[debian/amanda] / perl / Amanda / Config.pod

diff --git a/perl/Amanda/Config.pod b/perl/Amanda/Config.pod
index 5c88281b885073d2d848526eba4204f6c8153432..104cdd18a51ac1abca013cf4b64706ee3e1999ac 100644 (file)
--- a/perl/Amanda/Config.pod
+++ b/perl/Amanda/Config.pod
@@ -1,9 +1,10 @@
 /*
- * Copyright (c) 2009, 2010 Zmanda, Inc.  All Rights Reserved.
+ * Copyright (c) 2009-2012 Zmanda, Inc.  All Rights Reserved.
  *
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 as published
- * by the Free Software Foundation.
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful, but
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
@@ -41,8 +42,7 @@ Amanda::Config - access to Amanda configuration parameters
 
     print "tape device is ", getconf($CNF_TAPEDEV), "\n";
 
-This API closely parallels the C API.  See F<conffile.h> for details on the
-configuration parameter constants.
+This API closely parallels the C API.
 
 =head1 INITIALIZATION
 
@@ -248,6 +248,9 @@ values is straightforward:
   CONFTYPE_EXECUTE_WHERE              Math::BigInt
   CONFTYPE_SEND_AMREPORT_ON           Math::BigInt
   CONFTYPE_IDENTLIST                  [ string, .. ]
+  CONFTYPE_PART_CACHE_TYPE           Math::BigInt
+  CONFTYPE_RECOVERY_LIMIT             [ string, .. ] (undef if not specified;
+                                           undef in the list means same-host)
 
 Note that C<CONFTYPE_INTRANGE> and C<CONFTYPE_RATE> each return two values, not
 an array reference.
@@ -326,7 +329,14 @@ C<string_to_boolean()> takes a string and returns 0 if it matches any of
 Amanda's names for false, or 1 if matches a name for true. If it can't be
 interpreted, C<undef> is returned.
 
-=cut
+C<amandaify_property_name()> converts a string into Amanda's property style:
+all lower-case and with "-" replacing "_".
+
+=head1 CONSTANTS
 
+This section lists all of the configuration parameter constants defined in this
+module.  All of these constants are available with the C<:getconf> export tag.
+
+=cut
 
 %}