diff options
| author | ivan <ivan> | 2001-04-23 12:40:31 +0000 |
|---|---|---|
| committer | ivan <ivan> | 2001-04-23 12:40:31 +0000 |
| commit | f3235d39d083518d47f21cd5585e5f9a13070763 (patch) | |
| tree | eb1dbbe21e2bee5b92586c884bfc6025c5d035fe /htdocs/docs/man/FS/Conf.html | |
| parent | ece31063b782031e21ba1f57476afab555af5363 (diff) | |
documentation and webdemo updates
Diffstat (limited to 'htdocs/docs/man/FS/Conf.html')
| -rw-r--r-- | htdocs/docs/man/FS/Conf.html | 101 |
1 files changed, 44 insertions, 57 deletions
diff --git a/htdocs/docs/man/FS/Conf.html b/htdocs/docs/man/FS/Conf.html index 563eea878..7b1613efd 100644 --- a/htdocs/docs/man/FS/Conf.html +++ b/htdocs/docs/man/FS/Conf.html @@ -1,93 +1,80 @@ <HTML> <HEAD> <TITLE>FS::Conf - Read access to Freeside configuration values</TITLE> -<LINK REV="made" HREF="mailto:none"> +<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><A HREF="#SYNOPSIS">SYNOPSIS</A> - <LI><A HREF="#DESCRIPTION">DESCRIPTION</A> - <LI><A HREF="#METHODS">METHODS</A> - <LI><A HREF="#BUGS">BUGS</A> - <LI><A HREF="#SEE_ALSO">SEE ALSO</A> + <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 - +<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> -<P> -<PRE> use FS::Conf; -</PRE> -<P> -<PRE> $conf = new FS::Conf "/config/directory"; -</PRE> -<P> -<PRE> $FS::Conf::default_dir = "/config/directory"; - $conf = new FS::Conf; -</PRE> -<P> -<PRE> $dir = $conf->dir; -</PRE> -<P> -<PRE> $value = $conf->config('key'); +<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> + $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. - +<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> +<H1><A NAME="methods">METHODS</A></H1> <DL> -<DT><STRONG><A NAME="item_new">new [ DIRECTORY ]</A></STRONG><DD> -<P> -Create a new configuration object. A directory arguement is required if +<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. - -<DT><STRONG><A NAME="item_dir">dir</A></STRONG><DD> -<P> +<P></P> +<DT><STRONG><A NAME="item_dir">dir</A></STRONG><BR> +<DD> Returns the directory. - -<DT><STRONG><A NAME="item_config">config</A></STRONG><DD> -<P> +<P></P> +<DT><STRONG><A NAME="item_config">config</A></STRONG><BR> +<DD> Returns the configuration value or values (depending on context) for key. - -<DT><STRONG><A NAME="item_exists">exists</A></STRONG><DD> -<P> +<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. - -</DL> +<P></P></DL> <P> <HR> -<H1><A NAME="BUGS">BUGS</A></H1> -<P> -Write access (with locking) should be implemented. - +<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. +<H1><A NAME="see also">SEE ALSO</A></H1> +<P>config.html from the base documentation contains a list of configuration files.</P> </BODY> |