X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS.pm;h=60831ecd578aa898e8f0e90d54b75cfb1789e294;hb=9208e850bf047eb4a4438ad3958b7891370d2cb1;hp=d2c07e47c2a708745d07733333b3483a8ca41b1c;hpb=8ca6f203e5dae208d7af581d68671fe47c5e1a1a;p=freeside.git diff --git a/FS/FS.pm b/FS/FS.pm index d2c07e47c..60831ecd5 100644 --- a/FS/FS.pm +++ b/FS/FS.pm @@ -14,18 +14,17 @@ FS - Freeside Perl modules =head1 SYNOPSIS -FS is the unofficial (i.e. non-CPAN) prefix for the Perl module portion of the -Freeside ISP billing software. This includes: +Freeside perl modules and CLI utilities. =head2 Utility classes L - Freeside configuration values +L - Freeside configuration option meta-data. + L - User class (not yet OO) -L - 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 - Non OO-subroutines for the web interface. =head2 Database record classes @@ -58,6 +57,10 @@ L - Service definition class L - Column constraint class +L - External provisioning export class + +L - Export option class + L - Package (billing item) definition class L - Class linking package (billing item) @@ -85,6 +88,10 @@ L - Invoice class L - Invoice line item class +L - Invoice event definition class + +L - Completed invoice event class + L - Payment class L - Payment application class @@ -111,7 +118,27 @@ L - Job queue L - Job arguments -=head2 User Interface classes (under development; not yet usable) +=head1 Remote API modules + +L + +L + +L + +=head2 Command-line utilities + +L + +L + +L + +L + +L + +=head2 User Interface classes (under (stalled) development; not yet usable) L - User-interface base class @@ -137,17 +164,17 @@ Providers. The Freeside home page is at . -The main documentation is in htdocs/docs. - -=head1 VERSION - -$Id: FS.pm,v 1.9 2001-09-26 09:17:06 ivan Exp $ +The main documentation is in httemplate/docs. =head1 SUPPORT -A mailing list for users and developers is available. Send a blank message to +A mailing list for users is available. Send a blank message to 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 + to subscribe. + Commercial support is available; see . @@ -164,10 +191,6 @@ perl(1), main Freeside documentation in htdocs/docs/ =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. So far: DBIx::DBSchema, Net::SSH and Net::SCP...