X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2FConf.html;fp=htdocs%2Fdocs%2Fman%2FFS%2FConf.html;h=0000000000000000000000000000000000000000;hp=7b1613efdd93b2b9688c836ab78b226a83dfb78c;hb=1d758388ce3b17b8de1ae1d3a8ec39c1026baefc;hpb=e6cf4af2b9d3ffefebe1a3e358f0674f566b56bc diff --git a/htdocs/docs/man/FS/Conf.html b/htdocs/docs/man/FS/Conf.html deleted file mode 100644 index 7b1613efd..000000000 --- a/htdocs/docs/man/FS/Conf.html +++ /dev/null @@ -1,81 +0,0 @@ - - -FS::Conf - Read access to Freeside configuration values - - - - - - - - - - - -
-

-

NAME

-

FS::Conf - Read access to Freeside configuration values

-

-

-

SYNOPSIS

-
-  use FS::Conf;
-
-  $conf = new FS::Conf "/config/directory";
-
-  $FS::Conf::default_dir = "/config/directory";
-  $conf = new FS::Conf;
-
-  $dir = $conf->dir;
-
-  $value = $conf->config('key');
-  @list  = $conf->config('key');
-  $bool  = $conf->exists('key');
-

-

-

DESCRIPTION

-

Read access to Freeside configuration values. Keys currently map to filenames, -but this may change in the future.

-

-

-

METHODS

-
-
new [ DIRECTORY ]
-
-Create a new configuration object. A directory arguement is required if -$FS::Conf::default_dir has not been set. -

-
dir
-
-Returns the directory. -

-
config
-
-Returns the configuration value or values (depending on context) for key. -

-
exists
-
-Returns true if the specified key exists, even if the corresponding value -is undefined. -

-

-

-

BUGS

-

Write access (with locking) should be implemented.

-

-

-

SEE ALSO

-

config.html from the base documentation contains a list of configuration files.

- - - -