From 51984ac3d3da3006809c6866fdecd4ad83610731 Mon Sep 17 00:00:00 2001 From: ivan Date: Mon, 30 Jul 2001 07:36:04 +0000 Subject: templates!!! --- httemplate/docs/man/FS.html | 138 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 httemplate/docs/man/FS.html (limited to 'httemplate/docs/man/FS.html') diff --git a/httemplate/docs/man/FS.html b/httemplate/docs/man/FS.html new file mode 100644 index 000000000..23e8ca42f --- /dev/null +++ b/httemplate/docs/man/FS.html @@ -0,0 +1,138 @@ + + +FS - Freeside Perl modules + + + + + + + + + + + +
+

+

NAME

+

FS - Freeside Perl modules

+

+


+

SYNOPSIS

+

FS is the unofficial (i.e. non-CPAN) prefix for the Perl module portion of the +Freeside ISP billing software. This includes:

+

+

Utility classes

+

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

+

+

Database record classes

+

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

+

+

User Interface classes (under development; not yet usable)

+

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

+

+

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 2001-07-30 07:36:03 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.

+

+


+

SEE ALSO

+

perl(1), main Freeside documentation in htdocs/docs/

+

+


+

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. So far: DBIx::DBSchema, Net::SSH +and Net::SCP...

+ + + + -- cgit v1.2.1