htdocs/docs/man/Conf.txt

   1 NAME
   2     FS::Conf - Read access to Freeside configuration values
   3
   4 SYNOPSIS
   5       use FS::Conf;
   6
   7       $conf = new FS::Conf "/config/directory";
   8
   9       $FS::Conf::default_dir = "/config/directory";
  10       $conf = new FS::Conf;
  11
  12       $dir = $conf->dir;
  13
  14       $value = $conf->config('key');
  15       @list  = $conf->config('key');
  16       $bool  = $conf->exists('key');
  17
  18 DESCRIPTION
  19     Read access to Freeside configuration values. Keys currently map
  20     to filenames, but this may change in the future.
  21
  22 METHODS
  23     new [ DIRECTORY ]
  24         Create a new configuration object. A directory arguement is
  25         required if $FS::Conf::default_dir has not been set.
  26
  27     dir Returns the directory.
  28
  29     config
  30         Returns the configuration value or values (depending on
  31         context) for key.
  32
  33     exists
  34         Returns true if the specified key exists, even if the
  35         corresponding value is undefined.
  36
  37 BUGS
  38     Write access (with locking) should be implemented.
  39
  40 SEE ALSO
  41     config.html from the base documentation contains a list of
  42     configuration files.
  43
  44 HISTORY
  45     Ivan Kohler <ivan@sisd.com> 98-sep-6
  46
  47     sub exists forgot to fetch $dir ivan@sisd.com 98-sep-27
  48
  49     $Log: Conf.txt,v $
  50     Revision 1.4  1999-02-09 09:37:48  ivan
  51     regenerated perl api docs from embedded pod
  52  Revision 1.2 1998/11/13 04:08:44 ivan no
  53     default default_dir (ironic)
  54