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::ConfItem> - Freeside configuration option meta-data.
26 L<FS::UID> - User class (not yet OO)
28 L<FS::CGI> - Non OO-subroutines for the web interface. This is
29 depriciated. Future development will be focused on the FS::UI user-interface
32 =head2 Database record classes
34 L<FS::Record> - Database record base class
36 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
37 Office Protocol) class
39 L<FS::part_pop_local> - Local calling area class
41 L<FS::part_referral> - Referral class
43 L<FS::cust_main_county> - Locale (tax rate) class
45 L<FS::svc_Common> - Service base class
47 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
49 L<FS::svc_domain> - Domain class
51 L<FS::domain_record> - DNS zone entries
53 L<FS::svc_forward> - Mail forwarding class
55 L<FS::svc_acct_sm> - (Depreciated) Vitual mail alias class
57 L<FS::svc_www> - Web virtual host class.
59 L<FS::part_svc> - Service definition class
61 L<FS::part_svc_column> - Column constraint class
63 L<FS::part_pkg> - Package (billing item) definition class
65 L<FS::pkg_svc> - Class linking package (billing item)
66 definitions (see L<FS::part_pkg>) with service definitions
69 L<FS::agent> - Agent (reseller) class
71 L<FS::agent_type> - Agent type class
73 L<FS::type_pkgs> - Class linking agent types (see
74 L<FS::agent_type>) with package (billing item) definitions
77 L<FS::cust_svc> - Service class
79 L<FS::cust_pkg> - Package (billing item) class
81 L<FS::cust_main> - Customer class
83 L<FS::cust_main_invoice> - Invoice destination
86 L<FS::cust_bill> - Invoice class
88 L<FS::cust_bill_pkg> - Invoice line item class
90 L<FS::cust_pay> - Payment class
92 L<FS::cust_bill_pay> - Payment application class
94 L<FS::cust_credit> - Credit class
96 L<FS::cust_refund> - Refund class
98 L<FS::cust_credit_refund> - Refund application class
100 L<FS::cust_credit_bill> - Credit invoice application class
102 L<FS::cust_pay_batch> - Credit card transaction queue class
104 L<FS::prepay_credit> - Prepaid "calling card" credit class.
106 L<FS::nas> - Network Access Server class
108 L<FS::port> - NAS port class
110 L<FS::session> - User login session class
112 L<FS::queue> - Job queue
114 L<FS::queue_arg> - Job arguments
116 =head2 User Interface classes (under development; not yet usable)
118 L<FS::UI::Base> - User-interface base class
120 L<FS::UI::Gtk> - Gtk user-interface class
122 L<FS::UI::CGI> - CGI (HTML) user-interface class
124 L<FS::UI::agent> - agent table user-interface class
128 To quote perl(1), "If you're intending to read these straight through for the
129 first time, the suggested order will tend to reduce the number of forward
132 If you've never used OO modules before,
133 http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html might help you out.
137 Freeside is a billing and administration package for Internet Service
140 The Freeside home page is at <http://www.sisd.com/freeside>.
142 The main documentation is in htdocs/docs.
146 $Id: FS.pm,v 1.10 2001-10-24 15:29:30 ivan Exp $
150 A mailing list for users and developers is available. Send a blank message to
151 <ivan-freeside-subscribe@sisd.com> to subscribe.
153 Commercial support is available; see
154 <http://www.sisd.com/freeside/commercial.html>.
158 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
160 See the CREDITS file in the Freeside distribution for a (hopefully) complete
161 list and the individal files for details.
165 perl(1), main Freeside documentation in htdocs/docs/
169 The version number of the FS Perl extension differs from the version of the
170 Freeside distribution, which are both different from the CVS version tag for
171 each file, which appears under the VERSION heading.
173 Those modules which would be useful separately should be pulled out,
174 renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH