FS - Freeside Perl modules
FS is the temporary prefix for many disparate modules written for the Freeside ISP billing software. This includes:
FS::dbdef - Database class
FS::dbdef_table - Database table class
FS::dbdef_column - Database column class
FS::dbdef_colgroup - Database column group class
FS::dbdef_index - Database index class
FS::dbdef_unique - Database unique index class
FS::SSH - Simple wrappers around ssh and scp commands.
FS::Conf - Freeside configuration values
FS::UID - User class (not yet OO)
FS::CGI - Non OO-subroutines for the web interface. This is depriciated. Future development will be focused on the FS::UI user-interface classes (see below).
FS::Record - Database record base class
FS::svc_acct_pop - POP (Point of Presence, not Post Office Protocol) class
FS::part_referral - Referral class
FS::cust_main_county - Locale (tax rate) class
FS::svc_Common - Service base class
FS::svc_acct - Account (shell, RADIUS, POP3) class
FS::svc_domain - Domain class
FS::svc_acct_sm - Vitual mail alias class
FS::part_svc - Service definition class
FS::part_pkg - Package (billing item) definition class
FS::pkg_svc - Class linking package (billing item) definitions (see FS::part_pkg) with service definitions (see FS::part_svc)
FS::agent - Agent (reseller) class
FS::agent_type - Agent type class
FS::type_pkgs - Class linking agent types (see FS::agent_type) with package (billing item) definitions (see FS::part_pkg)
FS::cust_svc - Service class
FS::cust_pkg - Package (billing item) class
FS::cust_main - Customer class
FS::cust_main_invoice - Invoice destination class
FS::cust_bill - Invoice class
FS::cust_bill_pkg - Invoice line item class
FS::cust_pay - Payment class
FS::cust_credit - Credit class
FS::cust_refund - Refund class
FS::cust_pay_batch - Credit card transaction queue class
FS::UI::Base - User-interface base class
FS::UI::Gtk - Gtk user-interface class
FS::UI::CGI - CGI (HTML) user-interface class
FS::UI::agent - agent table user-interface class
To quote perl(1), ``If you're intending to read these straight
through for the first time, the suggested order will tend to reduce the
number of forward references.''
Freeside is a billing and administration package for Internet Service Providers.
The Freeside home page is at <http://www.sisd.com/freeside>.
The main documentation is in htdocs/docs.
$Id: FS.html,v 1.2 2000-03-03 18:22:42 ivan Exp $
A mailing list for users and developers is available. Send a blank message to <ivan-freeside-subscribe@sisd.com> to subscribe.
Commercial support is available; see <http://www.sisd.com/freeside/commercial.html>.
Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
See the CREDITS file in the Freeside distribution for a (hopefully) complete list and the individal files for details.
perl(1), main Freeside documentation in htdocs/docs/
The version number of the FS Perl extension differs from the version of the Freeside distribution, which are both different from the CVS version tag for each file, which appears under the VERSION heading.
Those modules which would be useful separately should be pulled out, renamed appropriately and uploaded to CPAN.