13 FS - Freeside Perl modules
17 Freeside perl modules and CLI utilities.
19 =head2 Utility classes
21 L<FS::Conf> - Freeside configuration values
23 L<FS::ConfItem> - Freeside configuration option meta-data.
25 L<FS::UID> - User class (not yet OO)
27 L<FS::CGI> - Non OO-subroutines for the web interface.
29 =head2 Database record classes
31 L<FS::Record> - Database record base class
33 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
34 Office Protocol) class
36 L<FS::part_pop_local> - Local calling area class
38 L<FS::part_referral> - Referral class
40 L<FS::cust_main_county> - Locale (tax rate) class
42 L<FS::svc_Common> - Service base class
44 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
46 L<FS::svc_domain> - Domain class
48 L<FS::domain_record> - DNS zone entries
50 L<FS::svc_forward> - Mail forwarding class
52 L<FS::svc_acct_sm> - (Depreciated) Vitual mail alias class
54 L<FS::svc_www> - Web virtual host class.
56 L<FS::part_svc> - Service definition class
58 L<FS::part_svc_column> - Column constraint class
60 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
61 with exports (see L<FS::part_export>)
63 L<FS::part_export> - External provisioning export class
65 L<FS::part_export_option> - Export option class
67 L<FS::part_pkg> - Package (billing item) definition class
69 L<FS::pkg_svc> - Class linking package (billing item)
70 definitions (see L<FS::part_pkg>) with service definitions
73 L<FS::agent> - Agent (reseller) class
75 L<FS::agent_type> - Agent type class
77 L<FS::type_pkgs> - Class linking agent types (see
78 L<FS::agent_type>) with package (billing item) definitions
81 L<FS::cust_svc> - Service class
83 L<FS::cust_pkg> - Package (billing item) class
85 L<FS::cust_main> - Customer class
87 L<FS::cust_main_invoice> - Invoice destination
90 L<FS::cust_bill> - Invoice class
92 L<FS::cust_bill_pkg> - Invoice line item class
94 L<FS::part_bill_event> - Invoice event definition class
96 L<FS::cust_bill_event> - Completed invoice event class
98 L<FS::cust_pay> - Payment class
100 L<FS::cust_bill_pay> - Payment application class
102 L<FS::cust_credit> - Credit class
104 L<FS::cust_refund> - Refund class
106 L<FS::cust_credit_refund> - Refund application class
108 L<FS::cust_credit_bill> - Credit invoice application class
110 L<FS::cust_pay_batch> - Credit card transaction queue class
112 L<FS::prepay_credit> - Prepaid "calling card" credit class.
114 L<FS::nas> - Network Access Server class
116 L<FS::port> - NAS port class
118 L<FS::session> - User login session class
120 L<FS::queue> - Job queue
122 L<FS::queue_arg> - Job arguments
124 =head1 Remote API modules
130 L<FS::MailAdminServer>
132 =head2 Command-line utilities
144 =head2 User Interface classes (under (stalled) development; not yet usable)
146 L<FS::UI::Base> - User-interface base class
148 L<FS::UI::Gtk> - Gtk user-interface class
150 L<FS::UI::CGI> - CGI (HTML) user-interface class
152 L<FS::UI::agent> - agent table user-interface class
156 To quote perl(1), "If you're intending to read these straight through for the
157 first time, the suggested order will tend to reduce the number of forward
160 If you've never used OO modules before,
161 http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html might help you out.
165 Freeside is a billing and administration package for Internet Service
168 The Freeside home page is at <http://www.sisd.com/freeside>.
170 The main documentation is in httemplate/docs.
174 A mailing list for users is available. Send a blank message to
175 <ivan-freeside-subscribe@sisd.com> to subscribe.
177 A mailing list for developers is available. It is intended to be lower volume
178 and higher SNR than the users list. Send a blank message to
179 <ivan-freeside-devel-subscribe@sisd.com> to subscribe.
181 Commercial support is available; see
182 <http://www.sisd.com/freeside/commercial.html>.
186 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
188 See the CREDITS file in the Freeside distribution for a (hopefully) complete
189 list and the individal files for details.
193 perl(1), main Freeside documentation in htdocs/docs/
197 Those modules which would be useful separately should be pulled out,
198 renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH