X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS.html;h=3d07462af9f27cc765373682753bbe1bd574feb1;hp=ab01acf99b4354aa1daca48027528b7c38fd946e;hb=f3235d39d083518d47f21cd5585e5f9a13070763;hpb=ece31063b782031e21ba1f57476afab555af5363 diff --git a/htdocs/docs/man/FS.html b/htdocs/docs/man/FS.html index ab01acf99..3d07462af 100644 --- a/htdocs/docs/man/FS.html +++ b/htdocs/docs/man/FS.html @@ -1,246 +1,137 @@
-
-FS - Freeside Perl modules - +
FS - Freeside Perl modules
-FS is the temporary prefix for many disparate modules written for the -Freeside ISP billing software. This includes: - +
FS is the unofficial (i.e. non-CPAN) prefix for the Perl module portion of the +Freeside ISP billing software. This includes:
++
the FS::Conf manpage - Freeside configuration values
+the FS::UID manpage - User class (not yet OO)
+the FS::CGI manpage - Non OO-subroutines for the web interface. This is +depriciated. Future development will be focused on the FS::UI user-interface +classes (see below).
++
the FS::Record manpage - Database record base class
+the FS::svc_acct_pop manpage - POP (Point of Presence, not Post +Office Protocol) class
+the FS::part_referral manpage - Referral class
+the FS::cust_main_county manpage - Locale (tax rate) class
+the FS::svc_Common manpage - Service base class
+the FS::svc_acct manpage - Account (shell, RADIUS, POP3) class
+the FS::svc_domain manpage - Domain class
+the FS::domain_record manpage - DNS zone entries
+the FS::svc_acct_sm manpage - Vitual mail alias class
+the FS::svc_www manpage - Web virtual host class.
+the FS::part_svc manpage - Service definition class
+the FS::part_pkg manpage - Package (billing item) definition class
+the FS::pkg_svc manpage - Class linking package (billing item) +definitions (see the FS::part_pkg manpage) with service definitions +(see the FS::part_svc manpage)
+the FS::agent manpage - Agent (reseller) class
+the FS::agent_type manpage - Agent type class
+the FS::type_pkgs manpage - Class linking agent types (see +the FS::agent_type manpage) with package (billing item) definitions +(see the FS::part_pkg manpage)
+the FS::cust_svc manpage - Service class
+the FS::cust_pkg manpage - Package (billing item) class
+the FS::cust_main manpage - Customer class
+the FS::cust_main_invoice manpage - Invoice destination +class
+the FS::cust_bill manpage - Invoice class
+the FS::cust_bill_pkg manpage - Invoice line item class
+the FS::cust_pay manpage - Payment class
+the FS::cust_credit manpage - Credit class
+the FS::cust_refund manpage - Refund class
+the FS::cust_pay_batch manpage - Credit card transaction queue class
+the FS::prepay_credit manpage - Prepaid ``calling card'' credit class.
+the FS::nas manpage - Network Access Server class
+the FS::port manpage - NAS port class
+the FS::session manpage - User login session class
++
the FS::UI::Base manpage - User-interface base class
+the FS::UI::Gtk manpage - Gtk user-interface class
+the FS::UI::CGI manpage - CGI (HTML) user-interface class
+the FS::UI::agent manpage - 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.''
-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 - +
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.
-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). - +
$Id: FS.html,v 1.3 2001-04-23 12:40:30 ivan Exp $
-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>. - +
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. - +
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/
-
+
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. +
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...