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::svc_broadband> - DSL, wireless and other broadband class.
71 L<FS::svc_external> - Externally tracked service class.
73 L<FS::part_svc> - Service definition class
75 L<FS::part_svc_column> - Column constraint class
77 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
78 with exports (see L<FS::part_export>)
80 L<FS::part_export> - External provisioning export class
82 L<FS::part_export_option> - Export option class
84 L<FS::part_pkg> - Package (billing item) definition class
86 L<FS::pkg_svc> - Class linking package (billing item)
87 definitions (see L<FS::part_pkg>) with service definitions
90 L<FS::agent> - Agent (reseller) class
92 L<FS::agent_type> - Agent type class
94 L<FS::type_pkgs> - Class linking agent types (see
95 L<FS::agent_type>) with package (billing item) definitions
98 L<FS::cust_svc> - Service class
100 L<FS::cust_pkg> - Package (billing item) class
102 L<FS::cust_main> - Customer class
104 L<FS::cust_main_invoice> - Invoice destination
107 L<FS::cust_bill> - Invoice class
109 L<FS::cust_bill_pkg> - Invoice line item class
111 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
113 L<FS::part_bill_event> - Invoice event definition class
115 L<FS::cust_bill_event> - Completed invoice event class
117 L<FS::cust_pay> - Payment class
119 L<FS::cust_bill_pay> - Payment application class
121 L<FS::cust_credit> - Credit class
123 L<FS::cust_refund> - Refund class
125 L<FS::cust_credit_refund> - Refund application to credit class
127 L<FS::cust_credit_bill> - Credit application to invoice class
129 L<FS::cust_pay_refund> - Refund application to payment class
131 L<FS::cust_pay_batch> - Credit card transaction queue class
133 L<FS::prepay_credit> - Prepaid "calling card" credit class.
135 L<FS::nas> - Network Access Server class
137 L<FS::port> - NAS port class
139 L<FS::session> - User login session class
141 L<FS::queue> - Job queue
143 L<FS::queue_arg> - Job arguments
145 L<FS::queue_depend> - Job dependencies
147 L<FS::msgcat> - Message catalogs
149 =head1 Remote API modules
157 L<FS::MailAdminServer> (deprecated in favor of the self-service server)
159 =head2 Command-line utilities
167 L<freeside-expiration-alerter>
171 L<freeside-cc-receipts-report>
173 L<freeside-credit-report>
175 L<freeside-receivables-report>
177 L<freeside-tax-report>
183 =head2 User Interface classes (under (stalled) development; not yet usable)
185 L<FS::UI::Base> - User-interface base class
187 L<FS::UI::Gtk> - Gtk user-interface class
189 L<FS::UI::CGI> - CGI (HTML) user-interface class
191 L<FS::UI::agent> - agent table user-interface class
195 To quote perl(1), "If you're intending to read these straight through for the
196 first time, the suggested order will tend to reduce the number of forward
199 If you've never used OO modules before,
200 http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
204 Freeside is a billing and administration package for Internet Service
207 The Freeside home page is at <http://www.sisd.com/freeside>.
209 The main documentation is in httemplate/docs.
213 A mailing list for users is available. Send a blank message to
214 <ivan-freeside-subscribe@sisd.com> to subscribe.
216 A mailing list for developers is available. It is intended to be lower volume
217 and higher SNR than the users list. Send a blank message to
218 <ivan-freeside-devel-subscribe@sisd.com> to subscribe.
220 Commercial support is available; see
221 <http://www.sisd.com/freeside/commercial.html>.
225 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
227 See the CREDITS file in the Freeside distribution for a (hopefully) complete
228 list and the individal files for details.
232 perl(1), main Freeside documentation in htdocs/docs/
236 Those modules which would be useful separately should be pulled out,
237 renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH