From 2c816f314a8f3cc46e72e31f34ed97b4e11d0449 Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 4 Aug 1999 12:13:27 +0000 Subject: new HTML manpages --- htdocs/docs/man/FS/Conf.html | 94 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 htdocs/docs/man/FS/Conf.html (limited to 'htdocs/docs/man/FS/Conf.html') diff --git a/htdocs/docs/man/FS/Conf.html b/htdocs/docs/man/FS/Conf.html new file mode 100644 index 000000000..e4555c3a9 --- /dev/null +++ b/htdocs/docs/man/FS/Conf.html @@ -0,0 +1,94 @@ + + +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. + +

NAME

SYNOPSIS

DESCRIPTION

METHODS

BUGS

SEE ALSO