<LI><A HREF="#utility classes">Utility classes</A></LI>
<LI><A HREF="#database record classes">Database record classes</A></LI>
- <LI><A HREF="#user interface classes (under development; not yet usable)">User Interface classes (under development; not yet usable)</A></LI>
+ </UL>
+
+ <LI><A HREF="#remote api modules">Remote API modules</A></LI>
+ <UL>
+
+ <LI><A HREF="#commandline utilities">Command-line utilities</A></LI>
+ <LI><A HREF="#user interface classes (under (stalled) development; not yet usable)">User Interface classes (under (stalled) development; not yet usable)</A></LI>
<LI><A HREF="#notes">Notes</A></LI>
</UL>
<LI><A HREF="#description">DESCRIPTION</A></LI>
- <LI><A HREF="#version">VERSION</A></LI>
<LI><A HREF="#support">SUPPORT</A></LI>
<LI><A HREF="#author">AUTHOR</A></LI>
<LI><A HREF="#see also">SEE ALSO</A></LI>
<P>
<HR>
<H1><A NAME="synopsis">SYNOPSIS</A></H1>
-<P>FS is the unofficial (i.e. non-CPAN) prefix for the Perl module portion of the
-Freeside ISP billing software. This includes:</P>
+<P>Freeside perl modules and CLI utilities.</P>
<P>
<H2><A NAME="utility classes">Utility classes</A></H2>
<P><A HREF="././FS/Conf.html">the FS::Conf manpage</A> - Freeside configuration values</P>
+<P><A HREF="././FS/ConfItem.html">the FS::ConfItem manpage</A> - Freeside configuration option meta-data.</P>
<P><A HREF="././FS/UID.html">the FS::UID manpage</A> - User class (not yet OO)</P>
-<P><A HREF="././FS/CGI.html">the FS::CGI manpage</A> - Non OO-subroutines for the web interface. This is
-depriciated. Future development will be focused on the FS::UI user-interface
-classes (see below).</P>
+<P><A HREF="././FS/CGI.html">the FS::CGI manpage</A> - Non OO-subroutines for the web interface.</P>
<P>
<H2><A NAME="database record classes">Database record classes</A></H2>
<P><A HREF="././FS/Record.html">the FS::Record manpage</A> - Database record base class</P>
<P><A HREF="././FS/svc_acct_pop.html">the FS::svc_acct_pop manpage</A> - POP (Point of Presence, not Post
Office Protocol) class</P>
+<P><A HREF="././FS/part_pop_local.html">the FS::part_pop_local manpage</A> - Local calling area class</P>
<P><A HREF="././FS/part_referral.html">the FS::part_referral manpage</A> - Referral class</P>
<P><A HREF="././FS/cust_main_county.html">the FS::cust_main_county manpage</A> - Locale (tax rate) class</P>
<P><A HREF="././FS/svc_Common.html">the FS::svc_Common manpage</A> - Service base class</P>
<P><A HREF="././FS/svc_acct.html">the FS::svc_acct manpage</A> - Account (shell, RADIUS, POP3) class</P>
<P><A HREF="././FS/svc_domain.html">the FS::svc_domain manpage</A> - Domain class</P>
<P><A HREF="././FS/domain_record.html">the FS::domain_record manpage</A> - DNS zone entries</P>
-<P><A HREF="././FS/svc_acct_sm.html">the FS::svc_acct_sm manpage</A> - Vitual mail alias class</P>
+<P><A HREF="././FS/svc_forward.html">the FS::svc_forward manpage</A> - Mail forwarding class</P>
+<P><A HREF="././FS/svc_acct_sm.html">the FS::svc_acct_sm manpage</A> - (Depreciated) Vitual mail alias class</P>
<P><A HREF="././FS/svc_www.html">the FS::svc_www manpage</A> - Web virtual host class.</P>
<P><A HREF="././FS/part_svc.html">the FS::part_svc manpage</A> - Service definition class</P>
+<P><A HREF="././FS/part_svc_column.html">the FS::part_svc_column manpage</A> - Column constraint class</P>
+<P><A HREF="././FS/part_export.html">the FS::part_export manpage</A> - External provisioning export class</P>
+<P><A HREF="././FS/part_export_option.html">the FS::part_export_option manpage</A> - Export option class</P>
<P><A HREF="././FS/part_pkg.html">the FS::part_pkg manpage</A> - Package (billing item) definition class</P>
<P><A HREF="././FS/pkg_svc.html">the FS::pkg_svc manpage</A> - Class linking package (billing item)
definitions (see <A HREF="././FS/part_pkg.html">the FS::part_pkg manpage</A>) with service definitions
class</P>
<P><A HREF="././FS/cust_bill.html">the FS::cust_bill manpage</A> - Invoice class</P>
<P><A HREF="././FS/cust_bill_pkg.html">the FS::cust_bill_pkg manpage</A> - Invoice line item class</P>
+<P><A HREF="././FS/part_bill_event.html">the FS::part_bill_event manpage</A> - Invoice event definition class</P>
+<P><A HREF="././FS/cust_bill_event.html">the FS::cust_bill_event manpage</A> - Completed invoice event class</P>
<P><A HREF="././FS/cust_pay.html">the FS::cust_pay manpage</A> - Payment class</P>
+<P><A HREF="././FS/cust_bill_pay.html">the FS::cust_bill_pay manpage</A> - Payment application class</P>
<P><A HREF="././FS/cust_credit.html">the FS::cust_credit manpage</A> - Credit class</P>
<P><A HREF="././FS/cust_refund.html">the FS::cust_refund manpage</A> - Refund class</P>
+<P><A HREF="././FS/cust_credit_refund.html">the FS::cust_credit_refund manpage</A> - Refund application class</P>
+<P><A HREF="././FS/cust_credit_bill.html">the FS::cust_credit_bill manpage</A> - Credit invoice application class</P>
<P><A HREF="././FS/cust_pay_batch.html">the FS::cust_pay_batch manpage</A> - Credit card transaction queue class</P>
<P><A HREF="././FS/prepay_credit.html">the FS::prepay_credit manpage</A> - Prepaid ``calling card'' credit class.</P>
<P><A HREF="././FS/nas.html">the FS::nas manpage</A> - Network Access Server class</P>
<P><A HREF="././FS/port.html">the FS::port manpage</A> - NAS port class</P>
<P><A HREF="././FS/session.html">the FS::session manpage</A> - User login session class</P>
+<P><A HREF="././FS/queue.html">the FS::queue manpage</A> - Job queue</P>
+<P><A HREF="././FS/queue_arg.html">the FS::queue_arg manpage</A> - Job arguments</P>
<P>
-<H2><A NAME="user interface classes (under development; not yet usable)">User Interface classes (under development; not yet usable)</A></H2>
+<HR>
+<H1><A NAME="remote api modules">Remote API modules</A></H1>
+<P><A HREF="./FS/SignupClient.html">the FS::SignupClient manpage</A></P>
+<P><A HREF="./FS/SessionClient.html">the FS::SessionClient manpage</A></P>
+<P><A HREF="./FS/MailAdminServer.html">the FS::MailAdminServer manpage</A></P>
+<P>
+<H2><A NAME="commandline utilities">Command-line utilities</A></H2>
+<P><A HREF="././bin/freeside-email.html">the freeside-email manpage</A></P>
+<P><A HREF="././bin/freeside-queued.html">the freeside-queued manpage</A></P>
+<P><A HREF="././bin/freeside-adduser.html">the freeside-adduser manpage</A></P>
+<P><A HREF="././bin/freeside-bill.html">the freeside-bill manpage</A></P>
+<P><A HREF="././bin/freeside-overdue.html">the freeside-overdue manpage</A></P>
+<P>
+<H2><A NAME="user interface classes (under (stalled) development; not yet usable)">User Interface classes (under (stalled) development; not yet usable)</A></H2>
<P><A HREF="././FS/UI/Base.html">the FS::UI::Base manpage</A> - User-interface base class</P>
<P><A HREF="././FS/UI/Gtk.html">the FS::UI::Gtk manpage</A> - Gtk user-interface class</P>
<P><A HREF="././FS/UI/CGI.html">the FS::UI::CGI manpage</A> - CGI (HTML) user-interface class</P>
<P>To quote perl(1), ``If you're intending to read these straight through for the
first time, the suggested order will tend to reduce the number of forward
references.''</P>
+<P>If you've never used OO modules before,
+<A HREF="http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html">http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html</A> might help you out.</P>
<P>
<HR>
<H1><A NAME="description">DESCRIPTION</A></H1>
<P>Freeside is a billing and administration package for Internet Service
Providers.</P>
<P>The Freeside home page is at <http://www.sisd.com/freeside>.</P>
-<P>The main documentation is in htdocs/docs.</P>
-<P>
-<HR>
-<H1><A NAME="version">VERSION</A></H1>
-<P>$Id: FS.html,v 1.1 2001-07-30 07:36:03 ivan Exp $</P>
+<P>The main documentation is in httemplate/docs.</P>
<P>
<HR>
<H1><A NAME="support">SUPPORT</A></H1>
-<P>A mailing list for users and developers is available. Send a blank message to
+<P>A mailing list for users is available. Send a blank message to
<<A HREF="mailto:ivan-freeside-subscribe@sisd.com">ivan-freeside-subscribe@sisd.com</A>> to subscribe.</P>
+<P>A mailing list for developers is available. It is intended to be lower volume
+and higher SNR than the users list. Send a blank message to
+<<A HREF="mailto:ivan-freeside-devel-subscribe@sisd.com">ivan-freeside-devel-subscribe@sisd.com</A>> to subscribe.</P>
<P>Commercial support is available; see
<http://www.sisd.com/freeside/commercial.html>.</P>
<P>
<P>
<HR>
<H1><A NAME="bugs">BUGS</A></H1>
-<P>The version number of the FS Perl extension differs from the version of the
-Freeside distribution, which are both different from the CVS version tag for
-each file, which appears under the VERSION heading.</P>
<P>Those modules which would be useful separately should be pulled out,
renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH
and Net::SCP...</P>
projects / freeside.git / blobdiff