3 <TITLE>FS - Freeside Perl modules</TITLE>
4 <LINK REV="made" HREF="mailto:none">
13 <LI><A HREF="#NAME">NAME</A>
14 <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
17 <LI><A HREF="#Database_metadata_classes">Database metadata classes</A>
18 <LI><A HREF="#Utility_classes">Utility classes</A>
19 <LI><A HREF="#Database_record_classes">Database record classes</A>
20 <LI><A HREF="#User_Interface_classes_under_de">User Interface classes (under development; not yet usable)</A>
21 <LI><A HREF="#Notes">Notes</A>
24 <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
25 <LI><A HREF="#VERSION">VERSION</A>
26 <LI><A HREF="#SUPPORT">SUPPORT</A>
27 <LI><A HREF="#AUTHOR">AUTHOR</A>
28 <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
29 <LI><A HREF="#BUGS">BUGS</A>
35 <H1><A NAME="NAME">NAME</A></H1>
37 FS - Freeside Perl modules
41 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
43 FS is the temporary prefix for many disparate modules written for the
44 Freeside ISP billing software. This includes:
48 <H2><A NAME="Database_metadata_classes">Database metadata classes</A></H2>
50 <A HREF="./FS/dbdef.html">FS::dbdef</A> - Database class
53 <A HREF="./FS/dbdef_table.html">FS::dbdef_table</A> - Database table class
56 <A HREF="./FS/dbdef_column.html">FS::dbdef_column</A> - Database column class
59 <A HREF="./FS/dbdef_colgroup.html">FS::dbdef_colgroup</A> - Database column group class
62 <A HREF="./FS/dbdef_index.html">FS::dbdef_index</A> - Database index class
65 <A HREF="./FS/dbdef_unique.html">FS::dbdef_unique</A> - Database unique index class
69 <H2><A NAME="Utility_classes">Utility classes</A></H2>
71 <A HREF="./FS/SSH.html">FS::SSH</A> - Simple wrappers around ssh and scp commands.
74 <A HREF="./FS/Conf.html">FS::Conf</A> - Freeside configuration values
77 <A HREF="./FS/UID.html">FS::UID</A> - User class (not yet OO)
80 <A HREF="./FS/CGI.html">FS::CGI</A> - Non OO-subroutines for the web interface. This is depriciated. Future
81 development will be focused on the FS::UI user-interface classes (see
86 <H2><A NAME="Database_record_classes">Database record classes</A></H2>
88 <A HREF="./FS/Record.html">FS::Record</A> - Database record base class
91 <A HREF="./FS/svc_acct_pop.html">FS::svc_acct_pop</A> - POP (Point of Presence, not Post Office Protocol) class
94 <A HREF="./FS/part_referral.html">FS::part_referral</A> - Referral class
97 <A HREF="./FS/cust_main_county.html">FS::cust_main_county</A> - Locale (tax rate) class
100 <A HREF="./FS/svc_Common.html">FS::svc_Common</A> - Service base class
103 <A HREF="./FS/svc_acct.html">FS::svc_acct</A> - Account (shell, RADIUS, POP3) class
106 <A HREF="./FS/svc_domain.html">FS::svc_domain</A> - Domain class
109 <A HREF="./FS/svc_acct_sm.html">FS::svc_acct_sm</A> - Vitual mail alias class
112 <A HREF="./FS/part_svc.html">FS::part_svc</A> - Service definition class
115 <A HREF="./FS/part_pkg.html">FS::part_pkg</A> - Package (billing item) definition class
118 <A HREF="./FS/pkg_svc.html">FS::pkg_svc</A> - Class linking package (billing item) definitions (see <A HREF="./FS/part_pkg.html">FS::part_pkg</A>) with service definitions (see <A HREF="./FS/part_svc.html">FS::part_svc</A>)
121 <A HREF="./FS/agent.html">FS::agent</A> - Agent (reseller) class
124 <A HREF="./FS/agent_type.html">FS::agent_type</A> - Agent type class
127 <A HREF="./FS/type_pkgs.html">FS::type_pkgs</A> - Class linking agent types (see
128 <A HREF="./FS/agent_type.html">FS::agent_type</A>) with package (billing item) definitions (see <A HREF="./FS/part_pkg.html">FS::part_pkg</A>)
131 <A HREF="./FS/cust_svc.html">FS::cust_svc</A> - Service class
134 <A HREF="./FS/cust_pkg.html">FS::cust_pkg</A> - Package (billing item) class
137 <A HREF="./FS/cust_main.html">FS::cust_main</A> - Customer class
140 <A HREF="./FS/cust_main_invoice.html">FS::cust_main_invoice</A> - Invoice destination class
143 <A HREF="./FS/cust_bill.html">FS::cust_bill</A> - Invoice class
146 <A HREF="./FS/cust_bill_pkg.html">FS::cust_bill_pkg</A> - Invoice line item class
149 <A HREF="./FS/cust_pay.html">FS::cust_pay</A> - Payment class
152 <A HREF="./FS/cust_credit.html">FS::cust_credit</A> - Credit class
155 <A HREF="./FS/cust_refund.html">FS::cust_refund</A> - Refund class
158 <A HREF="./FS/cust_pay_batch.html">FS::cust_pay_batch</A> - Credit card transaction queue class
162 <H2><A NAME="User_Interface_classes_under_de">User Interface classes (under development; not yet usable)</A></H2>
164 <A HREF="./FS/UI/Base.html">FS::UI::Base</A> - User-interface base class
167 <A HREF="./FS/UI/Gtk.html">FS::UI::Gtk</A> - Gtk user-interface class
170 <A HREF="./FS/UI/CGI.html">FS::UI::CGI</A> - CGI (HTML) user-interface class
173 <A HREF="./FS/UI/agent.html">FS::UI::agent</A> - agent table user-interface class
177 <H2><A NAME="Notes">Notes</A></H2>
179 To quote <CODE>perl(1),</CODE> ``If you're intending to read these straight
180 through for the first time, the suggested order will tend to reduce the
181 number of forward references.''
185 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
187 Freeside is a billing and administration package for Internet Service
191 The Freeside home page is at <http://www.sisd.com/freeside>.
194 The main documentation is in htdocs/docs.
198 <H1><A NAME="VERSION">VERSION</A></H1>
200 $Id: FS.html,v 1.2 2000-03-03 18:22:42 ivan Exp $
204 <H1><A NAME="SUPPORT">SUPPORT</A></H1>
206 A mailing list for users and developers is available. Send a blank message
208 HREF="mailto:ivan-freeside-subscribe@sisd.com">ivan-freeside-subscribe@sisd.com</A>>
212 Commercial support is available; see
213 <http://www.sisd.com/freeside/commercial.html>.
217 <H1><A NAME="AUTHOR">AUTHOR</A></H1>
219 Primarily Ivan Kohler <<A
220 HREF="mailto:ivan@sisd.com">ivan@sisd.com</A>>, with help from many kind
224 See the CREDITS file in the Freeside distribution for a (hopefully)
225 complete list and the individal files for details.
229 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
231 <CODE>perl(1),</CODE> main Freeside documentation in htdocs/docs/
235 <H1><A NAME="BUGS">BUGS</A></H1>
237 The version number of the FS Perl extension differs from the version of the
238 Freeside distribution, which are both different from the CVS version tag
239 for each file, which appears under the VERSION heading.
242 Those modules which would be useful separately should be pulled out,
243 renamed appropriately and uploaded to CPAN.