diff options
Diffstat (limited to 'httemplate/docs/man/FS/Conf.html')
| -rw-r--r-- | httemplate/docs/man/FS/Conf.html | 97 |
1 files changed, 0 insertions, 97 deletions
diff --git a/httemplate/docs/man/FS/Conf.html b/httemplate/docs/man/FS/Conf.html deleted file mode 100644 index be49be31f..000000000 --- a/httemplate/docs/man/FS/Conf.html +++ /dev/null @@ -1,97 +0,0 @@ -<HTML> -<HEAD> -<TITLE>FS::Conf - 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 - 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> -<PRE> - @config_items = $conf->config_items;</PRE> -<P> -<HR> -<H1><A NAME="description">DESCRIPTION</A></H1> -<P>Read and write 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> -<DT><STRONG><A NAME="item_touch">touch</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_set">set</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_config_items">config_items</A></STRONG><BR> -<DD> -Returns all of the possible configuration items as FS::ConfItem objects. See -<A HREF=".././FS/ConfItem.html">the FS::ConfItem manpage</A>. -<P></P></DL> -<P> -<HR> -<H1><A NAME="bugs">BUGS</A></H1> -<P>Write access (touch, set, delete) should be documented.</P> -<P>If this was more than just crud that will never be useful outside Freeside I'd -worry that config_items is freeside-specific and icky.</P> -<P> -<HR> -<H1><A NAME="see also">SEE ALSO</A></H1> -<P>``Configuration'' in the web interface (config/config.cgi).</P> -<P>httemplate/docs/config.html</P> - -</BODY> - -</HTML> |