From fa63948b49dedf0a1e0d2e857353188333092f33 Mon Sep 17 00:00:00 2001
From: ivan <ivan>
Date: Thu, 4 Oct 2007 01:15:05 +0000
Subject: [PATCH] update top-level FS manpage

---
 FS/FS.pm | 161 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 144 insertions(+), 17 deletions(-)

diff --git a/FS/FS.pm b/FS/FS.pm
index b18d7f7b2..d097071b7 100644
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -21,12 +21,20 @@ Freeside perl modules and CLI utilities.
 
 =head2 Utility classes
 
+L<FS::Schema> - Freeside database schema
+
+L<FS::Setup> - Setup subroutines
+
 L<FS::Conf> - Freeside configuration values
 
 L<FS::ConfItem> - Freeside configuration option meta-data.
 
+L<FS::ConfDefaults> - Freeside configuration default and available values
+
 L<FS::UID> - User class (not yet OO)
 
+L<FS::CurrentUser> -  Package representing the current user
+
 L<FS::CGI> - Non OO-subroutines for the web interface.
 
 L<FS::Msgcat> - Message catalog
@@ -35,10 +43,48 @@ L<FS::SearchCache> - Search cache
 
 L<FS::raddb> - RADIUS dictionary
 
+L<FS::AccessRight> - Access control rights.
+
+L<FS::Report> - Report data objects
+
+L<FS::Report::Table> - Report data objects
+
+L<FS::Report::Monthly> - Report data objects
+
+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
 
 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
+
+L<FS::access_groupagent> - Group reseller access
+
+L<FS::access_right> - Access rights
+
 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
 Office Protocol) class
 
@@ -50,8 +96,12 @@ 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
@@ -62,14 +112,36 @@ 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::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
@@ -81,6 +153,8 @@ 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
@@ -104,8 +178,13 @@ L<FS::agent> - Agent (reseller) class
 
 L<FS::agent_type> - Agent type class
 
-L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with
-package definitions (see L<FS::part_pkg>)
+L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with package definitions (see L<FS::part_pkg>)
+
+L<FS::payment_gateway> - Payment gateway class
+
+L<FS::payment_gateway_option> - Payment gateway option class
+
+L<FS::agent_payment_gateway> - Agent payment gateway class
 
 L<FS::cust_svc> - Service class
 
@@ -113,10 +192,21 @@ L<FS::cust_pkg> - Customer package class
 
 L<FS::cust_pkg_option> - Customer package option class
 
+L<FS::reason_type> - Reason type class
+
+L<FS::reason> - Reason class
+
+L<FS::cust_pkg_reason> - Package reason class
+
 L<FS::cust_main> - Customer class
 
-L<FS::cust_main_invoice> - Invoice destination
-class
+L<FS::cust_main_Mixin> - Mixin class for records that contain fields from cust_main
+
+L<FS::cust_main_invoice> - Invoice destination class
+
+L<FS::cust_main_note> - Customer note class
+
+L<FS::banned_pay> - Banned payment information class
 
 L<FS::cust_bill> - Invoice class
 
@@ -128,12 +218,18 @@ L<FS::part_bill_event> - Invoice event definition class
 
 L<FS::cust_bill_event> - Completed invoice event class
 
+L<FS::cust_bill_ApplicationCommon> - Base class for bill application classes
+
 L<FS::cust_pay> - Payment class
 
 L<FS::cust_pay_void> - Voided payment class
 
 L<FS::cust_bill_pay> - Payment application class
 
+L<FS::cust_bill_pay_pkg> - Line-item specific payment application class
+
+L<FS::cust_bill_pay_batch> - Batch payment application class
+
 L<FS::cust_credit> - Credit class
 
 L<FS::cust_refund> - Refund class
@@ -142,6 +238,8 @@ 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
@@ -168,7 +266,33 @@ L<FS::clientapi_session>
 
 L<FS::clientapi_session_field>
 
-=head1 Client API
+=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>
 
@@ -182,7 +306,7 @@ L<FS::ClientAPI::MyAccount>
 
 L<FS::ClientAPI::Agent>
 
-=head1 Remote API modules
+=head2 Remote API modules
 
 L<FS::SelfService>
 
@@ -192,6 +316,12 @@ 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>
@@ -216,11 +346,7 @@ L<freeside-bill>
 
 L<freeside-overdue>
 
-=head2 User Interface classes
-
-L<FS::UI::Web> - Web user-interface class
-
-=head2 Notes
+=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
@@ -231,12 +357,12 @@ 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 httemplate/docs.
+The main documentation is at <http://www.sisd.com/mediawiki>.
 
 =head1 SUPPORT
 
@@ -250,16 +376,17 @@ and higher SNR than the users list.  Send a blank message to
 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
 
-- 
2.11.0