13 FS - Freeside Perl modules
17 FS is the temporary prefix for many disparate modules written for the Freeside
18 ISP billing software. This includes:
20 =head2 Database metadata classes
22 L<FS::dbdef> - Database class
24 L<FS::dbdef_table> - Database table class
26 L<FS::dbdef_column> - Database column class
28 L<FS::dbdef_colgroup> - Database column group class
30 L<FS::dbdef_index> - Database index class
32 L<FS::dbdef_unique> - Database unique index class
34 =head2 Utility classes
36 L<FS::SSH> - Simple wrappers around ssh and scp commands.
38 L<FS::Conf> - Freeside configuration values
40 L<FS::UID> - User class (not yet OO)
42 L<FS::CGI> - Non OO-subroutines for the web interface. This is
43 depriciated. Future development will be focused on the FS::UI user-interface
46 =head2 Database record classes
48 L<FS::Record> - Database record base class
50 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
51 Office Protocol) class
53 L<FS::part_referral> - Referral class
55 L<FS::cust_main_county> - Locale (tax rate) class
57 L<FS::svc_Common> - Service base class
59 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
61 L<FS::svc_domain> - Domain class
63 L<FS::svc_acct_sm> - Vitual mail alias class
65 L<FS::part_svc> - Service definition 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::cust_pay> - Payment class
96 L<FS::cust_credit> - Credit class
98 L<FS::cust_refund> - Refund class
100 L<FS::cust_pay_batch> - Credit card transaction queue
103 =head2 User Interface classes (under development; not yet usable)
105 L<FS::UI::Base> - User-interface base class
107 L<FS::UI::Gtk> - Gtk user-interface class
109 L<FS::UI::CGI> - CGI (HTML) user-interface class
111 L<FS::UI::agent> - agent table user-interface class
115 To quote perl(1), "If you're intending to read these straight through for the
116 first time, the suggested order will tend to reduce the number of forward
121 Freeside is a billing and administration package for Internet Service
124 The Freeside home page is at <http://www.sisd.com/freeside>.
126 The main documentation is in htdocs/docs.
130 $Id: FS.pm,v 1.3 1999-08-04 12:41:47 ivan Exp $
134 A mailing list for users and developers is available. Send a blank message to
135 <ivan-freeside-subscribe@sisd.com> to subscribe.
137 Commercial support is available; see
138 <http://www.sisd.com/freeside/commercial.html>.
142 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
144 See the CREDITS file in the Freeside distribution for a (hopefully) complete
145 list and the individal files for details.
149 perl(1), main Freeside documentation in htdocs/docs/
153 The version number of the FS Perl extension differs from the version of the
154 Freeside distribution, which are both different from the CVS version tag for
155 each file, which appears under the VERSION heading.
157 Those modules which would be useful separately should be pulled out,
158 renamed appropriately and uploaded to CPAN.