From 2c816f314a8f3cc46e72e31f34ed97b4e11d0449 Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 4 Aug 1999 12:13:27 +0000 Subject: new HTML manpages --- htdocs/docs/man/FS.html | 247 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 247 insertions(+) create mode 100644 htdocs/docs/man/FS.html (limited to 'htdocs/docs/man/FS.html') diff --git a/htdocs/docs/man/FS.html b/htdocs/docs/man/FS.html new file mode 100644 index 000000000..b2f0dd3a2 --- /dev/null +++ b/htdocs/docs/man/FS.html @@ -0,0 +1,247 @@ + + +FS - Freeside Perl modules + + + + + + + +

+ + +

NAME

+FS - Freeside Perl modules + +

SYNOPSIS

+FS is the temporary prefix for many disparate modules written for the +Freeside ISP billing software. This includes: + +

Database metadata classes

+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 + +

Utility classes

+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). + +

Database record classes

+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 + +

User Interface classes (under development; not yet usable)

+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 + +

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.'' + +

DESCRIPTION

+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. + +

VERSION

+$Id: FS.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

SUPPORT

+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>. + +

AUTHOR

+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. + +

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. + + + + -- cgit v1.2.1