diff options
Diffstat (limited to 'httemplate/docs/man/FS/svc_www.html')
| -rw-r--r-- | httemplate/docs/man/FS/svc_www.html | 134 |
1 files changed, 0 insertions, 134 deletions
diff --git a/httemplate/docs/man/FS/svc_www.html b/httemplate/docs/man/FS/svc_www.html deleted file mode 100644 index 0e7f4f197..000000000 --- a/httemplate/docs/man/FS/svc_www.html +++ /dev/null @@ -1,134 +0,0 @@ -<HTML> -<HEAD> -<TITLE>FS::svc_www - Object methods for svc_www records</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="#version">VERSION</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::svc_www - Object methods for svc_www records</P> -<P> -<HR> -<H1><A NAME="synopsis">SYNOPSIS</A></H1> -<PRE> - use FS::svc_www;</PRE> -<PRE> - $record = new FS::svc_www \%hash; - $record = new FS::svc_www { 'column' => 'value' };</PRE> -<PRE> - $error = $record->insert;</PRE> -<PRE> - $error = $new_record->replace($old_record);</PRE> -<PRE> - $error = $record->delete;</PRE> -<PRE> - $error = $record->check;</PRE> -<PRE> - $error = $record->suspend;</PRE> -<PRE> - $error = $record->unsuspend;</PRE> -<PRE> - $error = $record->cancel;</PRE> -<P> -<HR> -<H1><A NAME="description">DESCRIPTION</A></H1> -<P>An FS::svc_www object represents an web virtual host. FS::svc_www inherits -from FS::svc_Common. The following fields are currently supported:</P> -<DL> -<DT><STRONG><A NAME="item_svcnum_%2D_primary_key">svcnum - primary key</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_recnum_%2D_DNS_%60A%27_record_corresponding_to_thi">recnum - DNS `A' record corresponding to this web virtual host. (see <A HREF=".././FS/domain_record.html">the FS::domain_record manpage</A>)</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_account">usersvc - account (see <A HREF=".././FS/svc_acct.html">the FS::svc_acct manpage</A>) corresponding to this web virtual host.</A></STRONG><BR> -<DD> -</DL> -<P> -<HR> -<H1><A NAME="methods">METHODS</A></H1> -<DL> -<DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR> -<DD> -Creates a new web virtual host. To add the record to the database, see -<A HREF="#insert">insert</A>. -<P>Note that this stores the hash reference, not a distinct copy of the hash it -points to. You can ask the object for a copy with the <EM>hash</EM> method.</P> -<P></P> -<DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR> -<DD> -Adds this record to the database. If there is an error, returns the error, -otherwise returns false. -<P>The additional fields pkgnum and svcpart (see <A HREF=".././FS/cust_svc.html">the FS::cust_svc manpage</A>) should be -defined. An FS::cust_svc record will be created and inserted.</P> -<P>If the configuration values (see <A HREF=".././FS/Conf.html">the FS::Conf manpage</A>) <EM>apachemachine</EM>, and -<EM>apacheroot</EM> exist, the command:</P> -<PRE> - mkdir $apacheroot/$zone; - chown $username $apacheroot/$zone; - ln -s $apacheroot/$zone $homedir/$zone</PRE> -<P><EM>$zone</EM> is the DNS A record pointed to by <EM>recnum</EM> -<EM>$username</EM> is the username pointed to by <EM>usersvc</EM> -<EM>$homedir</EM> is that user's home directory</P> -<P>is executed on <EM>apachemachine</EM> via ssh. This behaviour can be surpressed by -setting $FS::svc_www::nossh_hack true.</P> -<P></P> -<DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR> -<DD> -Delete this record from the database. -<P></P> -<DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR> -<DD> -Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -<P></P> -<DT><STRONG><A NAME="item_suspend">suspend</A></STRONG><BR> -<DD> -Called by the suspend method of FS::cust_pkg (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>). -<P></P> -<DT><STRONG><A NAME="item_unsuspend">unsuspend</A></STRONG><BR> -<DD> -Called by the unsuspend method of FS::cust_pkg (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>). -<P></P> -<DT><STRONG><A NAME="item_cancel">cancel</A></STRONG><BR> -<DD> -Called by the cancel method of FS::cust_pkg (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>). -<P></P> -<DT><STRONG><A NAME="item_check">check</A></STRONG><BR> -<DD> -Checks all fields to make sure this is a valid example. If there is -an error, returns the error, otherwise returns false. Called by the insert -and repalce methods. -<P></P></DL> -<P> -<HR> -<H1><A NAME="version">VERSION</A></H1> -<P>$Id: svc_www.html,v 1.3 2002-01-29 17:42:46 ivan Exp $</P> -<P> -<HR> -<H1><A NAME="bugs">BUGS</A></H1> -<P> -<HR> -<H1><A NAME="see also">SEE ALSO</A></H1> -<P><A HREF=".././FS/svc_Common.html">the FS::svc_Common manpage</A>, <A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/domain_record.html">the FS::domain_record manpage</A>, <A HREF=".././FS/cust_svc.html">the FS::cust_svc manpage</A>, -<A HREF=".././FS/part_svc.html">the FS::part_svc manpage</A>, <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>, schema.html from the base documentation.</P> - -</BODY> - -</HTML> |