X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS.pm;h=462815db3d716a72b84c59f90e0a6f869cee05ca;hb=3a977998566f58dd5b16745f95cf6f30a27f0b0a;hp=78317392a61ce6293d652738b3bc7038656af35f;hpb=75e22f3c399435c50ed5698cb7c19d0e9f2617f8;p=freeside.git

diff --git a/FS/FS.pm b/FS/FS.pm
index 78317392a..462815db3 100644
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -3,7 +3,10 @@ package FS;
 use strict;
 use vars qw($VERSION);
 
-$VERSION = '0.01';
+$VERSION = '%%%VERSION%%%';
+
+#find missing entries in this file with:
+# for a in `ls *pm | cut -d. -f1`; do grep 'L<FS::'$a'>' ../FS.pm >/dev/null || echo "missing $a" ; done
 
 1;
 __END__
@@ -14,162 +17,384 @@ FS - Freeside Perl modules
 
 =head1 SYNOPSIS
 
-FS is the temporary prefix for many disparate modules written for the Freeside
-ISP billing software.  This includes:
+Freeside perl modules and CLI utilities.
+
+=head2 Utility classes
 
-=head2 Database metadata classes
+L<FS::Schema> - Freeside database schema
 
-=over 4
+L<FS::Setup> - Setup subroutines
 
-=item L<FS::dbdef|FS::dbdef> - Database class
+L<FS::Conf> - Freeside configuration values
 
-=item L<FS::dbdef_table|FS::dbdef_table> - Database table class
+L<FS::ConfItem> - Freeside configuration option meta-data.
 
-=item L<FS::dbdef_column|FS::dbdef_column> - Database column class
+L<FS::ConfDefaults> - Freeside configuration default and available values
 
-=item L<FS::dbdef_colgroup|FS::dbdef_colgroup> - Database column group class
+L<FS::UID> - User class (not yet OO)
 
-=item L<FS::dbdef_index|FS::dbdef_index> - Database index class
+L<FS::CurrentUser> -  Package representing the current user
 
-=item L<FS::dbdef_unique|FS::dbdef_unique> - Database unique index class
+L<FS::CGI> - Non OO-subroutines for the web interface.
 
-=back
+L<FS::Msgcat> - Message catalog
 
-=head2 Utility classes
+L<FS::SearchCache> - Search cache
 
-=over 4
+L<FS::raddb> - RADIUS dictionary
 
-=item L<FS::SSH|FS::SSH> - Simple wrappers around ssh and scp commands.
+L<FS::AccessRight> - Access control rights.
 
-=item L<FS::Conf|FS::Conf> - Freeside configuration values
+L<FS::Report> - Report data objects
 
-=item L<FS::UID|FS::UID> - User class (not yet OO)
+L<FS::Report::Table> - Report data objects
 
-=item L<FS::CGI|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).
+L<FS::Report::Monthly> - Report data objects
 
-=back
+L<FS::XMLRPC> - Backend XML::RPC server
+
+L<FS::Misc> - Miscellaneous subroutines
+
+L<FS::payby> - Payment types
+
+L<FS::Pony> - A pony
 
 =head2 Database record classes
 
-=over 4
+L<FS::Record> - Database record base class
+
+L<FS::m2m_Common> - Mixin class for classes in a many-to-many relationship
+
+L<FS::m2name_Common> - Base class for tables with a related table listing names
+
+L<FS::option_Common> - Base class for option sub-classes
+
+L<FS::pkg_class> - Package class class
+
+L<FS::payinfo_Mixin>  - Mixin class for records in tables that contain payinfo.
+
+L<FS::access_user> - Employees / internal users
+
+L<FS::access_user_pref> - Employee preferences
+
+L<FS::access_group> - Employee groups
+
+L<FS::access_usergroup> - Employee group membership
 
-=item L<FS::Record|FS::Record> - Database record base class
+L<FS::access_groupagent> - Group reseller access
 
-=item L<FS::svc_acct_pop|FS::svc_acct_pop> - POP (Point of Presence, not Post
+L<FS::access_right> - Access rights
+
+L<FS::svc_acct_pop> - POP (Point of Presence, not Post
 Office Protocol) class
 
-=item L<FS::part_referral|FS::part_referral> - Referral 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::cust_tax_exempt> - Tax exemption record class
+
+L<FS::cust_tax_exempt_pkg> - Line-item specific tax exemption record class
+
+L<FS::svc_Common> - Service base class
+
+L<FS::svc_Parent_Mixin> - Mixin class for svc_ classes with a parent_svcnum field
+
+L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
+
+L<FS::acct_snarf> - External mail account class
+
+L<FS::radius_usergroup> - RADIUS groups
+
+L<FS::svc_domain> - Domain class
+
+L<FS::domain_record> - DNS zone entries
+
+L<FS::registrar> - Domain registrar class
+
+L<FS::svc_forward> - Mail forwarding class
+
+L<FS::svc_www> - Web virtual host class.
+
+L<FS::svc_broadband> - DSL, wireless and other broadband class.
+
+L<FS::addr_block> - Address block class
+
+L<FS::router> - Router class
+
+L<FS::part_virtual_field> - Broadband virtual field class
+
+L<FS::svc_phone> - Phone service class
+
+L<FS::cdr> - Call Detail Record class
+
+L<FS::cdr_calltype> - CDR calltype class
+
+L<FS::cdr_carrier> - CDR carrier class
+
+L<FS::cdr_upstream_rate> - CDR upstream rate class
+
+L<FS::cdr_type> - CDR type class
+
+L<FS::svc_external> - Externally tracked service class.
+
+L<FS::inventory_class> - Inventory classes
+
+L<FS::inventory_item> - Inventory items
+
+L<FS::part_svc> - Service definition class
+
+L<FS::part_svc_column> - Column constraint class
+
+L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
+with exports (see L<FS::part_export>)
+
+L<FS::part_export> - External provisioning export class
+
+L<FS::part_export_option> - Export option class
+
+L<FS::pkg_class> - Package class class
+
+L<FS::part_pkg> - Package definition class
+
+L<FS::part_pkg_option> - Package definition option class
+
+L<FS::pkg_svc> - Class linking package definitions (see L<FS::part_pkg>) with
+service definitions (see L<FS::part_svc>)
+
+L<FS::reg_code> - One-time registration codes
+
+L<FS::reg_code_pkg> - Class linking registration codes (see L<FS::reg_code>) with package definitions (see L<FS::part_pkg>)
+
+L<FS::rate> - Rate plans for call billing
+
+L<FS::rate_region> - Rate regions for call billing
+
+L<FS::rate_prefix> - Rate region prefixes for call billing
+
+L<FS::rate_detail> - Rate plan detail for call billing
+
+L<FS::agent> - Agent (reseller) class
+
+L<FS::agent_type> - Agent type class
 
-=item L<FS::cust_main_county|FS::cust_main_county> - Locale (tax rate) class
+L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with package definitions (see L<FS::part_pkg>)
 
-=item L<FS::svc_Common|FS::svc_Common> - Service base class
+L<FS::payment_gateway> - Payment gateway class
 
-=item L<FS::svc_acct|FS::svc_acct> - Account (shell, RADIUS, POP3) class
+L<FS::payment_gateway_option> - Payment gateway option class
 
-=item L<FS::svc_domain|FS::svc_domain> - Domain class
+L<FS::agent_payment_gateway> - Agent payment gateway class
 
-=item L<FS::svc_acct_sm|FS::svc_acct_sm> - Vitual mail alias class
+L<FS::cust_svc> - Service class
 
-=item L<FS::part_svc|FS::part_svc> - Service definition class
+L<FS::cust_pkg> - Customer package class
 
-=item L<FS::part_pkg|FS::part_pkg> - Package (billing item) definition class
+L<FS::cust_pkg_option> - Customer package option class
 
-=item L<FS::pkg_svc|FS::pkg_svc> - Class linking package (billing item)
-definitions (see L<FS::part_pkg>) with service definitions
-(see L<FS::part_svc>)
+L<FS::reason_type> - Reason type class
 
-=item L<FS::agent|FS::agent> - Agent (reseller) class
+L<FS::reason> - Reason class
 
-=item L<FS::agent_type|FS::agent_type> - Agent type class
+L<FS::cust_pkg_reason> - Package reason class
 
-=item L<FS::type_pkgs|FS::type_pkgs> - Class linking agent types (see
-L<FS::agent_type>) with package (billing item) definitions
-(see L<FS::part_pkg>)
+L<FS::cust_main> - Customer class
 
-=item L<FS::cust_svc|FS::cust_svc> - Service class
+L<FS::cust_main_Mixin> - Mixin class for records that contain fields from cust_main
 
-=item L<FS::cust_pkg|FS::cust_pkg> - Package (billing item) class
+L<FS::cust_main_invoice> - Invoice destination class
 
-=item L<FS::cust_main|FS::cust_main> - Customer class
+L<FS::cust_main_note> - Customer note class
 
-=item L<FS::cust_main_invoice|FS::cust_main_invoice> - Invoice destination
-class
+L<FS::banned_pay> - Banned payment information class
 
-=item L<FS::cust_bill|FS::cust_bill> - Invoice class
+L<FS::cust_bill> - Invoice class
 
-=item L<FS::cust_bill_pkg|FS::cust_bill_pkg> - Invoice line item class
+L<FS::cust_bill_pkg> - Invoice line item class
 
-=item L<FS::cust_pay|FS::cust_pay> - Payment class
+L<FS::cust_bill_pkg_detail> - Invoice line item detail class
 
-=item L<FS::cust_credit|FS::cust_credit> - Credit class
+L<FS::part_bill_event> - Invoice event definition class
 
-=item L<FS::cust_refund|FS::cust_refund> - Refund class
+L<FS::cust_bill_event> - Completed invoice event class
 
-=item L<FS::cust_pay_batch|FS::cust_pay_batch> - Credit card transaction queue
-class
+L<FS::cust_bill_ApplicationCommon> - Base class for bill application classes
 
-=back
+L<FS::cust_pay> - Payment class
 
-=head2 User Interface classes (under development; not yet usable)
+L<FS::cust_pay_void> - Voided payment class
 
-=over 4
+L<FS::cust_bill_pay> - Payment application class
 
-=item L<FS::UI::Base|FS::UI::Base> - User-interface base class
+L<FS::cust_bill_pay_pkg> - Line-item specific payment application class
 
-=item L<FS::UI::Gtk|FS::UI::Gtk> - Gtk user-interface class
+L<FS::cust_bill_pay_batch> - Batch payment application class
 
-=item L<FS::UI::CGI|FS::UI::CGI> - CGI (HTML) user-interface class
+L<FS::cust_credit> - Credit class
 
-=item L<FS::UI::agent|FS::UI::agent> - agent table user-interface class
+L<FS::cust_refund> - Refund class
 
-=back
+L<FS::cust_credit_refund> - Refund application to credit class
+
+L<FS::cust_credit_bill> - Credit application to invoice class
+
+L<FS::cust_credit_bill_pkg> - Line-item specific credit application to invoice class
+
+L<FS::cust_pay_refund> - Refund application to payment class
+
+L<FS::pay_batch> - Credit card transaction queue class
+
+L<FS::cust_pay_batch> - Credit card transaction member 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
+
+L<FS::queue_depend> - Job dependencies
+
+L<FS::msgcat> - Message catalogs
+
+L<FS::clientapi_session>
+
+L<FS::clientapi_session_field>
+
+=head2 Historical database record classes
+
+L<FS::h_Common> - History table base class
+
+L<FS::h_cust_bill> - Historical record of customer tax changes (old-style)
+
+L<FS::h_cust_svc> - Object method for h_cust_svc objects
+
+L<FS::h_cust_tax_exempt> - Historical record of customer tax changes (old-style)
+
+L<FS::h_domain_record> - Historical DNS entry objects
+
+L<FS::h_svc_acct> - Historical account objects
+
+L<FS::h_svc_broadband> - Historical broadband connection objects
+
+L<FS::h_svc_domain> - Historical domain objects
+
+L<FS::h_svc_external> - Historical externally tracked service objects
+
+L<FS::h_svc_forward> - Historical mail forwarding alias objects
+
+L<FS::h_svc_phone> - Historical phone number objects
+
+L<FS::h_svc_www> - Historical web virtual host objects
+
+=head2 Client API
+
+L<FS::ClientAPI>
+
+L<FS::ClientAPI_SessionCache>
+
+L<FS::ClientAPI::Signup>
+
+L<FS::ClientAPI::passwd>
+
+L<FS::ClientAPI::MyAccount>
+
+L<FS::ClientAPI::Agent>
+
+=head2 Remote API modules
+
+L<FS::SelfService>
+
+L<FS::SignupClient>
+
+L<FS::SessionClient>
+
+L<FS::MailAdminServer> (deprecated in favor of the self-service server)
+
+=head2 User Interface classes
+
+L<FS::UI::Web> - Web user-interface class
+
+L<FS::UI::bytecount> - Byte counter user-interface class
+
+=head2 Command-line utilities
+
+L<freeside-adduser>
+
+L<freeside-queued>
+
+L<freeside-daily>
+
+L<freeside-expiration-alerter>
+
+L<freeside-email>
+
+L<freeside-cc-receipts-report>
+
+L<freeside-credit-report>
+
+L<freeside-receivables-report>
+
+L<freeside-tax-report>
+
+L<freeside-bill>
+
+L<freeside-overdue>
+
+=head1 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."
 
+If you've never used OO modules before,
+http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
+
 =head1 DESCRIPTION
 
-Freeside is a billing and administration package for Internet Service
-Providers.
+Freeside is a billing and administration package for wired and wireless ISPs,
+VoIP, hosting, service and content providers and other online businesses.
 
 The Freeside home page is at <http://www.sisd.com/freeside>.
 
-The main documentation is in htdocs/docs.
-
-=head1 VERSION
-
-$Id: FS.pm,v 1.2 1999-08-04 07:34:15 ivan Exp $
+The main documentation is at <http://www.sisd.com/mediawiki>.
 
 =head1 SUPPORT
 
-A mailing list for users and developers is available.  Send a blank message to
-<ivan-freeside-subscribe@sisd.com> to subscribe.
+A mailing list for users is available.  Send a blank message to
+<freeside-users-subscribe@sisd.com> to subscribe.
+
+A mailing list for developers is available.  It is intended to be lower volume
+and higher SNR than the users list.  Send a blank message to
+<freeside-devel-subscribe@sisd.com> to subscribe.
 
 Commercial support is available; see
 <http://www.sisd.com/freeside/commercial.html>.
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
+Primarily Ivan Kohler, with help from many kind folks, including core
+contributors Jeff Finucane, Kristian Hoffman, Jason Hall and Peter Bowen.
 
 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/
+perl(1), main Freeside documentation at <http://www.sisd.com/mediawiki/>
 
 =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.
+renamed appropriately and uploaded to CPAN.  So far: DBIx::DBSchema, Net::SSH
+and Net::SCP...
 
 =cut