13 FS - Freeside Perl modules
17 FS is the unofficial (i.e. non-CPAN) prefix for the Perl module portion of the
18 Freeside ISP billing software. This includes:
20 =head2 Utility classes
22 L<FS::Conf> - Freeside configuration values
24 L<FS::UID> - User class (not yet OO)
26 L<FS::CGI> - Non OO-subroutines for the web interface. This is
27 depriciated. Future development will be focused on the FS::UI user-interface
30 =head2 Database record classes
32 L<FS::Record> - Database record base class
34 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
35 Office Protocol) class
37 L<FS::part_referral> - Referral class
39 L<FS::cust_main_county> - Locale (tax rate) class
41 L<FS::svc_Common> - Service base class
43 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
45 L<FS::svc_domain> - Domain class
47 L<FS::domain_record> - DNS zone entries
49 L<FS::svc_forward> - Mail forwarding class
51 L<FS::svc_acct_sm> - (Depreciated) Vitual mail alias class
53 L<FS::svc_www> - Web virtual host class.
55 L<FS::part_svc> - Service definition class
57 L<FS::part_svc_column> - Column constraint class
59 L<FS::part_pkg> - Package (billing item) definition class
61 L<FS::pkg_svc> - Class linking package (billing item)
62 definitions (see L<FS::part_pkg>) with service definitions
65 L<FS::agent> - Agent (reseller) class
67 L<FS::agent_type> - Agent type class
69 L<FS::type_pkgs> - Class linking agent types (see
70 L<FS::agent_type>) with package (billing item) definitions
73 L<FS::cust_svc> - Service class
75 L<FS::cust_pkg> - Package (billing item) class
77 L<FS::cust_main> - Customer class
79 L<FS::cust_main_invoice> - Invoice destination
82 L<FS::cust_bill> - Invoice class
84 L<FS::cust_bill_pkg> - Invoice line item class
86 L<FS::cust_pay> - Payment class
88 L<FS::cust_bill_pay> - Payment application class
90 L<FS::cust_credit> - Credit class
92 L<FS::cust_refund> - Refund class
94 L<FS::cust_credit_refund> - Refund application class
96 L<FS::cust_credit_bill> - Refund invoice application class
98 L<FS::cust_pay_batch> - Credit card transaction queue class
100 L<FS::prepay_credit> - Prepaid "calling card" credit class.
102 L<FS::nas> - Network Access Server class
104 L<FS::port> - NAS port class
106 L<FS::session> - User login session class
108 =head2 User Interface classes (under development; not yet usable)
110 L<FS::UI::Base> - User-interface base class
112 L<FS::UI::Gtk> - Gtk user-interface class
114 L<FS::UI::CGI> - CGI (HTML) user-interface class
116 L<FS::UI::agent> - agent table user-interface class
120 To quote perl(1), "If you're intending to read these straight through for the
121 first time, the suggested order will tend to reduce the number of forward
124 If you've never used OO modules before,
125 http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html might help you out.
129 Freeside is a billing and administration package for Internet Service
132 The Freeside home page is at <http://www.sisd.com/freeside>.
134 The main documentation is in htdocs/docs.
138 $Id: FS.pm,v 1.7 2001-09-06 20:41:59 ivan Exp $
142 A mailing list for users and developers is available. Send a blank message to
143 <ivan-freeside-subscribe@sisd.com> to subscribe.
145 Commercial support is available; see
146 <http://www.sisd.com/freeside/commercial.html>.
150 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
152 See the CREDITS file in the Freeside distribution for a (hopefully) complete
153 list and the individal files for details.
157 perl(1), main Freeside documentation in htdocs/docs/
161 The version number of the FS Perl extension differs from the version of the
162 Freeside distribution, which are both different from the CVS version tag for
163 each file, which appears under the VERSION heading.
165 Those modules which would be useful separately should be pulled out,
166 renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH