htdocs/docs/man/FS.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS - Freeside Perl modules</TITLE>
   4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <A NAME="__index__"></A>
  10 <!-- INDEX BEGIN -->
  11
  12 <UL>
  13
  14         <LI><A HREF="#name">NAME</A></LI>
  15         <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  16         <UL>
  17
  18                 <LI><A HREF="#utility classes">Utility classes</A></LI>
  19                 <LI><A HREF="#database record classes">Database record classes</A></LI>
  20                 <LI><A HREF="#user interface classes (under development; not yet usable)">User Interface classes (under development; not yet usable)</A></LI>
  21                 <LI><A HREF="#notes">Notes</A></LI>
  22         </UL>
  23
  24         <LI><A HREF="#description">DESCRIPTION</A></LI>
  25         <LI><A HREF="#version">VERSION</A></LI>
  26         <LI><A HREF="#support">SUPPORT</A></LI>
  27         <LI><A HREF="#author">AUTHOR</A></LI>
  28         <LI><A HREF="#see also">SEE ALSO</A></LI>
  29         <LI><A HREF="#bugs">BUGS</A></LI>
  30 </UL>
  31 <!-- INDEX END -->
  32
  33 <HR>
  34 <P>
  35 <H1><A NAME="name">NAME</A></H1>
  36 <P>FS - Freeside Perl modules</P>
  37 <P>
  38 <HR>
  39 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  40 <P>FS is the unofficial (i.e. non-CPAN) prefix for the Perl module portion of the
  41 Freeside ISP billing software.  This includes:</P>
  42 <P>
  43 <H2><A NAME="utility classes">Utility classes</A></H2>
  44 <P><A HREF="././FS/Conf.html">the FS::Conf manpage</A> - Freeside configuration values</P>
  45 <P><A HREF="././FS/UID.html">the FS::UID manpage</A> - User class (not yet OO)</P>
  46 <P><A HREF="././FS/CGI.html">the FS::CGI manpage</A> - Non OO-subroutines for the web interface.  This is
  47 depriciated.  Future development will be focused on the FS::UI user-interface
  48 classes (see below).</P>
  49 <P>
  50 <H2><A NAME="database record classes">Database record classes</A></H2>
  51 <P><A HREF="././FS/Record.html">the FS::Record manpage</A> - Database record base class</P>
  52 <P><A HREF="././FS/svc_acct_pop.html">the FS::svc_acct_pop manpage</A> - POP (Point of Presence, not Post
  53 Office Protocol) class</P>
  54 <P><A HREF="././FS/part_referral.html">the FS::part_referral manpage</A> - Referral class</P>
  55 <P><A HREF="././FS/cust_main_county.html">the FS::cust_main_county manpage</A> - Locale (tax rate) class</P>
  56 <P><A HREF="././FS/svc_Common.html">the FS::svc_Common manpage</A> - Service base class</P>
  57 <P><A HREF="././FS/svc_acct.html">the FS::svc_acct manpage</A> - Account (shell, RADIUS, POP3) class</P>
  58 <P><A HREF="././FS/svc_domain.html">the FS::svc_domain manpage</A> - Domain class</P>
  59 <P><A HREF="././FS/domain_record.html">the FS::domain_record manpage</A> - DNS zone entries</P>
  60 <P><A HREF="././FS/svc_acct_sm.html">the FS::svc_acct_sm manpage</A> - Vitual mail alias class</P>
  61 <P><A HREF="././FS/svc_www.html">the FS::svc_www manpage</A> - Web virtual host class.</P>
  62 <P><A HREF="././FS/part_svc.html">the FS::part_svc manpage</A> - Service definition class</P>
  63 <P><A HREF="././FS/part_pkg.html">the FS::part_pkg manpage</A> - Package (billing item) definition class</P>
  64 <P><A HREF="././FS/pkg_svc.html">the FS::pkg_svc manpage</A> - Class linking package (billing item)
  65 definitions (see <A HREF="././FS/part_pkg.html">the FS::part_pkg manpage</A>) with service definitions
  66 (see <A HREF="././FS/part_svc.html">the FS::part_svc manpage</A>)</P>
  67 <P><A HREF="././FS/agent.html">the FS::agent manpage</A> - Agent (reseller) class</P>
  68 <P><A HREF="././FS/agent_type.html">the FS::agent_type manpage</A> - Agent type class</P>
  69 <P><A HREF="././FS/type_pkgs.html">the FS::type_pkgs manpage</A> - Class linking agent types (see
  70 <A HREF="././FS/agent_type.html">the FS::agent_type manpage</A>) with package (billing item) definitions
  71 (see <A HREF="././FS/part_pkg.html">the FS::part_pkg manpage</A>)</P>
  72 <P><A HREF="././FS/cust_svc.html">the FS::cust_svc manpage</A> - Service class</P>
  73 <P><A HREF="././FS/cust_pkg.html">the FS::cust_pkg manpage</A> - Package (billing item) class</P>
  74 <P><A HREF="././FS/cust_main.html">the FS::cust_main manpage</A> - Customer class</P>
  75 <P><A HREF="././FS/cust_main_invoice.html">the FS::cust_main_invoice manpage</A> - Invoice destination
  76 class</P>
  77 <P><A HREF="././FS/cust_bill.html">the FS::cust_bill manpage</A> - Invoice class</P>
  78 <P><A HREF="././FS/cust_bill_pkg.html">the FS::cust_bill_pkg manpage</A> - Invoice line item class</P>
  79 <P><A HREF="././FS/cust_pay.html">the FS::cust_pay manpage</A> - Payment class</P>
  80 <P><A HREF="././FS/cust_credit.html">the FS::cust_credit manpage</A> - Credit class</P>
  81 <P><A HREF="././FS/cust_refund.html">the FS::cust_refund manpage</A> - Refund class</P>
  82 <P><A HREF="././FS/cust_pay_batch.html">the FS::cust_pay_batch manpage</A> - Credit card transaction queue class</P>
  83 <P><A HREF="././FS/prepay_credit.html">the FS::prepay_credit manpage</A> - Prepaid ``calling card'' credit class.</P>
  84 <P><A HREF="././FS/nas.html">the FS::nas manpage</A> - Network Access Server class</P>
  85 <P><A HREF="././FS/port.html">the FS::port manpage</A> - NAS port class</P>
  86 <P><A HREF="././FS/session.html">the FS::session manpage</A> - User login session class</P>
  87 <P>
  88 <H2><A NAME="user interface classes (under development; not yet usable)">User Interface classes (under development; not yet usable)</A></H2>
  89 <P><A HREF="././FS/UI/Base.html">the FS::UI::Base manpage</A> - User-interface base class</P>
  90 <P><A HREF="././FS/UI/Gtk.html">the FS::UI::Gtk manpage</A> - Gtk user-interface class</P>
  91 <P><A HREF="././FS/UI/CGI.html">the FS::UI::CGI manpage</A> - CGI (HTML) user-interface class</P>
  92 <P><A HREF="././FS/UI/agent.html">the FS::UI::agent manpage</A> - agent table user-interface class</P>
  93 <P>
  94 <H2><A NAME="notes">Notes</A></H2>
  95 <P>To quote perl(1), ``If you're intending to read these straight through for the
  96 first time, the suggested order will tend to reduce the number of forward
  97 references.''</P>
  98 <P>
  99 <HR>
 100 <H1><A NAME="description">DESCRIPTION</A></H1>
 101 <P>Freeside is a billing and administration package for Internet Service
 102 Providers.</P>
 103 <P>The Freeside home page is at &lt;http://www.sisd.com/freeside&gt;.</P>
 104 <P>The main documentation is in htdocs/docs.</P>
 105 <P>
 106 <HR>
 107 <H1><A NAME="version">VERSION</A></H1>
 108 <P>$Id: FS.html,v 1.3 2001-04-23 12:40:30 ivan Exp $</P>
 109 <P>
 110 <HR>
 111 <H1><A NAME="support">SUPPORT</A></H1>
 112 <P>A mailing list for users and developers is available.  Send a blank message to
 113 &lt;<A HREF="mailto:ivan-freeside-subscribe@sisd.com">ivan-freeside-subscribe@sisd.com</A>&gt; to subscribe.</P>
 114 <P>Commercial support is available; see
 115 &lt;http://www.sisd.com/freeside/commercial.html&gt;.</P>
 116 <P>
 117 <HR>
 118 <H1><A NAME="author">AUTHOR</A></H1>
 119 <P>Primarily Ivan Kohler &lt;<A HREF="mailto:ivan@sisd.com">ivan@sisd.com</A>&gt;, with help from many kind folks.</P>
 120 <P>See the CREDITS file in the Freeside distribution for a (hopefully) complete
 121 list and the individal files for details.</P>
 122 <P>
 123 <HR>
 124 <H1><A NAME="see also">SEE ALSO</A></H1>
 125 <P>perl(1), main Freeside documentation in htdocs/docs/</P>
 126 <P>
 127 <HR>
 128 <H1><A NAME="bugs">BUGS</A></H1>
 129 <P>The version number of the FS Perl extension differs from the version of the
 130 Freeside distribution, which are both different from the CVS version tag for
 131 each file, which appears under the VERSION heading.</P>
 132 <P>Those modules which would be useful separately should be pulled out,
 133 renamed appropriately and uploaded to CPAN.  So far: DBIx::DBSchema, Net::SSH
 134 and Net::SCP...</P>
 135
 136 </BODY>
 137
 138 </HTML>