8 #find missing entries in this file with:
9 # for a in `ls *pm | cut -d. -f1`; do grep 'L<FS::'$a'>' ../FS.pm >/dev/null || echo "missing $a" ; done
16 FS - Freeside Perl modules
20 Freeside perl modules and CLI utilities.
22 =head2 Utility classes
24 L<FS::Conf> - Freeside configuration values
26 L<FS::ConfItem> - Freeside configuration option meta-data.
28 L<FS::UID> - User class (not yet OO)
30 L<FS::CGI> - Non OO-subroutines for the web interface.
32 L<FS::Msgcat> - Message catalog
34 L<FS::SearchCache> - Search cache
36 L<FS::raddb> - RADIUS dictionary
38 =head2 Database record classes
40 L<FS::Record> - Database record base class
42 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
43 Office Protocol) class
45 L<FS::part_pop_local> - Local calling area class
47 L<FS::part_referral> - Referral class
49 L<FS::cust_main_county> - Locale (tax rate) class
51 L<FS::cust_tax_exempt> - Tax exemption record class
53 L<FS::svc_Common> - Service base class
55 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
57 L<FS::acct_snarf> - External mail account class
59 L<FS::radius_usergroup> - RADIUS groups
61 L<FS::svc_domain> - Domain class
63 L<FS::domain_record> - DNS zone entries
65 L<FS::svc_forward> - Mail forwarding class
67 L<FS::svc_www> - Web virtual host class.
69 L<FS::part_svc> - Service definition class
71 L<FS::part_svc_column> - Column constraint class
73 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
74 with exports (see L<FS::part_export>)
76 L<FS::part_export> - External provisioning export class
78 L<FS::part_export_option> - Export option class
80 L<FS::part_pkg> - Package (billing item) definition class
82 L<FS::pkg_svc> - Class linking package (billing item)
83 definitions (see L<FS::part_pkg>) with service definitions
86 L<FS::agent> - Agent (reseller) class
88 L<FS::agent_type> - Agent type class
90 L<FS::type_pkgs> - Class linking agent types (see
91 L<FS::agent_type>) with package (billing item) definitions
94 L<FS::cust_svc> - Service class
96 L<FS::cust_pkg> - Package (billing item) class
98 L<FS::cust_main> - Customer class
100 L<FS::cust_main_invoice> - Invoice destination
103 L<FS::cust_bill> - Invoice class
105 L<FS::cust_bill_pkg> - Invoice line item class
107 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
109 L<FS::part_bill_event> - Invoice event definition class
111 L<FS::cust_bill_event> - Completed invoice event class
113 L<FS::cust_pay> - Payment class
115 L<FS::cust_bill_pay> - Payment application class
117 L<FS::cust_credit> - Credit class
119 L<FS::cust_refund> - Refund class
121 L<FS::cust_credit_refund> - Refund application class
123 L<FS::cust_credit_bill> - Credit invoice application class
125 L<FS::cust_pay_batch> - Credit card transaction queue class
127 L<FS::prepay_credit> - Prepaid "calling card" credit class.
129 L<FS::nas> - Network Access Server class
131 L<FS::port> - NAS port class
133 L<FS::session> - User login session class
135 L<FS::queue> - Job queue
137 L<FS::queue_arg> - Job arguments
139 L<FS::queue_depend> - Job dependencies
141 L<FS::msgcat> - Message catalogs
143 =head1 Remote API modules
149 L<FS::MailAdminServer>
151 =head2 Command-line utilities
159 L<freeside-expiration-alerter>
163 L<freeside-cc-receipts-report>
165 L<freeside-credit-report>
167 L<freeside-receivables-report>
169 L<freeside-tax-report>
175 =head2 User Interface classes (under (stalled) development; not yet usable)
177 L<FS::UI::Base> - User-interface base class
179 L<FS::UI::Gtk> - Gtk user-interface class
181 L<FS::UI::CGI> - CGI (HTML) user-interface class
183 L<FS::UI::agent> - agent table user-interface class
187 To quote perl(1), "If you're intending to read these straight through for the
188 first time, the suggested order will tend to reduce the number of forward
191 If you've never used OO modules before,
192 http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
196 Freeside is a billing and administration package for Internet Service
199 The Freeside home page is at <http://www.sisd.com/freeside>.
201 The main documentation is in httemplate/docs.
205 A mailing list for users is available. Send a blank message to
206 <ivan-freeside-subscribe@sisd.com> to subscribe.
208 A mailing list for developers is available. It is intended to be lower volume
209 and higher SNR than the users list. Send a blank message to
210 <ivan-freeside-devel-subscribe@sisd.com> to subscribe.
212 Commercial support is available; see
213 <http://www.sisd.com/freeside/commercial.html>.
217 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
219 See the CREDITS file in the Freeside distribution for a (hopefully) complete
220 list and the individal files for details.
224 perl(1), main Freeside documentation in htdocs/docs/
228 Those modules which would be useful separately should be pulled out,
229 renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH