summaryrefslogtreecommitdiff
path: root/htdocs/docs/man/Conf.txt
blob: c46c9ee6ad23c5560676a1485609d533efeed819 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
NAME
    FS::Conf - Read access to Freeside configuration values

SYNOPSIS
      use FS::Conf;

      $conf = new FS::Conf;
      $conf = new FS::Conf "/non/standard/config/directory";

      $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. Optionally, a non-default
        directory may be specified.

    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
    The option to specify a non-default directory should probably be
    removed.

    Write access (with locking) should be implemented.

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

HISTORY
    Ivan Kohler <ivan@sisd.com> 98-sep-6