package FS; use strict; use vars qw($VERSION); $VERSION = '0.01'; 1; __END__ =head1 NAME FS - Freeside Perl modules =head1 SYNOPSIS FS is the unofficial (i.e. non-CPAN) prefix for the Perl module portion of the Freeside ISP billing software. This includes: =head2 Utility classes L - Freeside configuration values L - User class (not yet OO) L - Non OO-subroutines for the web interface. This is depriciated. Future development will be focused on the FS::UI user-interface classes (see below). =head2 Database record classes L - Database record base class L - POP (Point of Presence, not Post Office Protocol) class L - Referral class L - Locale (tax rate) class L - Service base class L - Account (shell, RADIUS, POP3) class L - Domain class L - DNS zone entries L - Vitual mail alias class L - Web virtual host class. L - Service definition class L - Package (billing item) definition class L - Class linking package (billing item) definitions (see L) with service definitions (see L) L - Agent (reseller) class L - Agent type class L - Class linking agent types (see L) with package (billing item) definitions (see L) L - Service class L - Package (billing item) class L - Customer class L - Invoice destination class L - Invoice class L - Invoice line item class L - Payment class L - Credit class L - Refund class L - Credit card transaction queue class L - Prepaid "calling card" credit class. L - Network Access Server class L - NAS port class L - User login session class =head2 User Interface classes (under development; not yet usable) L - User-interface base class L - Gtk user-interface class L - CGI (HTML) user-interface class L - agent table user-interface class =head2 Notes 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." =head1 DESCRIPTION Freeside is a billing and administration package for Internet Service Providers. The Freeside home page is at . The main documentation is in htdocs/docs. =head1 VERSION $Id: FS.pm,v 1.5 2001-04-23 12:40:30 ivan Exp $ =head1 SUPPORT A mailing list for users and developers is available. Send a blank message to to subscribe. Commercial support is available; see . =head1 AUTHOR Primarily Ivan Kohler , 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. =head1 SEE ALSO perl(1), main Freeside documentation in htdocs/docs/ =head1 BUGS 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. So far: DBIx::DBSchema, Net::SSH and Net::SCP... =cut