summaryrefslogtreecommitdiff
path: root/htdocs/docs/man/Conf.txt
blob: 01b7cf5e6f244d33d06f6952c3f9c8d78ec005de (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
48
49
50
51
52
53
54
55
56
57
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.

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

    sub exists forgot to fetch $dir ivan@sisd.com 98-sep-27

    $Log: Conf.txt,v $
    Revision 1.5  1999-04-08 13:39:31  ivan
    convert from pod for 1.2.0 release
 Revision 1.3 1999/03/29 01:29:33 ivan die
    unless the configuration directory exists

    Revision 1.2 1998/11/13 04:08:44 ivan no default default_dir
    (ironic)