=head1 SYNOPSIS
-FS is the temporary prefix for many disparate modules written for the Freeside
-ISP billing software. This includes:
-
-=head2 Database metadata classes
-
-L<FS::dbdef> - Database class
-
-L<FS::dbdef_table> - Database table class
-
-L<FS::dbdef_column> - Database column class
-
-L<FS::dbdef_colgroup> - Database column group class
-
-L<FS::dbdef_index> - Database index class
-
-L<FS::dbdef_unique> - Database unique index class
+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<FS::SSH> - Simple wrappers around ssh and scp commands.
-
L<FS::Conf> - Freeside configuration values
+L<FS::ConfItem> - Freeside configuration option meta-data.
+
L<FS::UID> - User class (not yet OO)
L<FS::CGI> - Non OO-subroutines for the web interface. This is
L<FS::svc_acct_pop> - POP (Point of Presence, not Post
Office Protocol) class
+L<FS::part_pop_local> - Local calling area class
+
L<FS::part_referral> - Referral class
L<FS::cust_main_county> - Locale (tax rate) class
L<FS::svc_domain> - Domain class
-L<FS::svc_acct_sm> - Vitual mail alias class
+L<FS::domain_record> - DNS zone entries
+
+L<FS::svc_forward> - Mail forwarding class
+
+L<FS::svc_acct_sm> - (Depreciated) Vitual mail alias class
+
+L<FS::svc_www> - Web virtual host class.
L<FS::part_svc> - Service definition class
+L<FS::part_svc_column> - Column constraint class
+
L<FS::part_pkg> - Package (billing item) definition class
L<FS::pkg_svc> - Class linking package (billing item)
L<FS::cust_pay> - Payment class
+L<FS::cust_bill_pay> - Payment application class
+
L<FS::cust_credit> - Credit class
L<FS::cust_refund> - Refund class
-L<FS::cust_pay_batch> - Credit card transaction queue
-class
+L<FS::cust_credit_refund> - Refund application class
+
+L<FS::cust_credit_bill> - Credit invoice application class
+
+L<FS::cust_pay_batch> - Credit card transaction queue class
+
+L<FS::prepay_credit> - Prepaid "calling card" credit class.
+
+L<FS::nas> - Network Access Server class
+
+L<FS::port> - NAS port class
+
+L<FS::session> - User login session class
+
+L<FS::queue> - Job queue
+
+L<FS::queue_arg> - Job arguments
=head2 User Interface classes (under development; not yet usable)
first time, the suggested order will tend to reduce the number of forward
references."
+If you've never used OO modules before,
+http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html might help you out.
+
=head1 DESCRIPTION
Freeside is a billing and administration package for Internet Service
=head1 VERSION
-$Id: FS.pm,v 1.3 1999-08-04 12:41:47 ivan Exp $
+$Id: FS.pm,v 1.10 2001-10-24 15:29:30 ivan Exp $
=head1 SUPPORT
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.
+renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH
+and Net::SCP...
=cut