diff options
Diffstat (limited to 'httemplate/docs/man/FS/Conf.html')
-rw-r--r-- | httemplate/docs/man/FS/Conf.html | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/httemplate/docs/man/FS/Conf.html b/httemplate/docs/man/FS/Conf.html new file mode 100644 index 000000000..7b1613efd --- /dev/null +++ b/httemplate/docs/man/FS/Conf.html @@ -0,0 +1,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> |