X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2FConf.html;h=7b1613efdd93b2b9688c836ab78b226a83dfb78c;hp=e4555c3a9fb3ea737048a7bc6241e4f643663eb8;hb=e6cf4af2b9d3ffefebe1a3e358f0674f566b56bc;hpb=2c816f314a8f3cc46e72e31f34ed97b4e11d0449 diff --git a/htdocs/docs/man/FS/Conf.html b/htdocs/docs/man/FS/Conf.html index e4555c3a9..7b1613efd 100644 --- a/htdocs/docs/man/FS/Conf.html +++ b/htdocs/docs/man/FS/Conf.html @@ -1,93 +1,80 @@ FS::Conf - Read access to Freeside configuration values - + +

NAME -
SYNOPSIS -
DESCRIPTION -
METHODS -
BUGS -
SEE ALSO +
NAME
SYNOPSIS
DESCRIPTION
METHODS
BUGS
SEE ALSO

NAME

-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');
+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');
-
+  $bool  = $conf->exists('key');

DESCRIPTION

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

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 +

new [ DIRECTORY ]
+

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

dir

dir
+

Returns the directory. - -

config

config
+

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

exists

exists
+

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

BUGS

-Write access (with locking) should be implemented. - +

BUGS

Write access (with locking) should be implemented.