blob: 7b1613efdd93b2b9688c836ab78b226a83dfb78c (
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
<HTML>
<HEAD>
<TITLE>FS::Conf - Read access to Freeside configuration values</TITLE>
<LINK REV="made" HREF="mailto:perl@packages.debian.org">
</HEAD>
<BODY>
<A NAME="__index__"></A>
<!-- INDEX BEGIN -->
<UL>
<LI><A HREF="#name">NAME</A></LI>
<LI><A HREF="#synopsis">SYNOPSIS</A></LI>
<LI><A HREF="#description">DESCRIPTION</A></LI>
<LI><A HREF="#methods">METHODS</A></LI>
<LI><A HREF="#bugs">BUGS</A></LI>
<LI><A HREF="#see also">SEE ALSO</A></LI>
</UL>
<!-- INDEX END -->
<HR>
<P>
<H1><A NAME="name">NAME</A></H1>
<P>FS::Conf - Read access to Freeside configuration values</P>
<P>
<HR>
<H1><A NAME="synopsis">SYNOPSIS</A></H1>
<PRE>
use FS::Conf;</PRE>
<PRE>
$conf = new FS::Conf "/config/directory";</PRE>
<PRE>
$FS::Conf::default_dir = "/config/directory";
$conf = new FS::Conf;</PRE>
<PRE>
$dir = $conf->dir;</PRE>
<PRE>
$value = $conf->config('key');
@list = $conf->config('key');
$bool = $conf->exists('key');</PRE>
<P>
<HR>
<H1><A NAME="description">DESCRIPTION</A></H1>
<P>Read access to Freeside configuration values. Keys currently map to filenames,
but this may change in the future.</P>
<P>
<HR>
<H1><A NAME="methods">METHODS</A></H1>
<DL>
<DT><STRONG><A NAME="item_new_%5B_DIRECTORY_%5D">new [ DIRECTORY ]</A></STRONG><BR>
<DD>
Create a new configuration object. A directory arguement is required if
$FS::Conf::default_dir has not been set.
<P></P>
<DT><STRONG><A NAME="item_dir">dir</A></STRONG><BR>
<DD>
Returns the directory.
<P></P>
<DT><STRONG><A NAME="item_config">config</A></STRONG><BR>
<DD>
Returns the configuration value or values (depending on context) for key.
<P></P>
<DT><STRONG><A NAME="item_exists">exists</A></STRONG><BR>
<DD>
Returns true if the specified key exists, even if the corresponding value
is undefined.
<P></P></DL>
<P>
<HR>
<H1><A NAME="bugs">BUGS</A></H1>
<P>Write access (with locking) should be implemented.</P>
<P>
<HR>
<H1><A NAME="see also">SEE ALSO</A></H1>
<P>config.html from the base documentation contains a list of configuration files.</P>
</BODY>
</HTML>
|
