httemplate/docs/man/FS.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS - Freeside Perl modules</TITLE>
   4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <A NAME="__index__"></A>
  10 <!-- INDEX BEGIN -->
  11
  12 <UL>
  13
  14         <LI><A HREF="#name">NAME</A></LI>
  15         <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  16         <UL>
  17
  18                 <LI><A HREF="#utility classes">Utility classes</A></LI>
  19                 <LI><A HREF="#database record classes">Database record classes</A></LI>
  20         </UL>
  21
  22         <LI><A HREF="#remote api modules">Remote API modules</A></LI>
  23         <UL>
  24
  25                 <LI><A HREF="#commandline utilities">Command-line utilities</A></LI>
  26                 <LI><A HREF="#user interface classes (under (stalled) development; not yet usable)">User Interface classes (under (stalled) development; not yet usable)</A></LI>
  27                 <LI><A HREF="#notes">Notes</A></LI>
  28         </UL>
  29
  30         <LI><A HREF="#description">DESCRIPTION</A></LI>
  31         <LI><A HREF="#support">SUPPORT</A></LI>
  32         <LI><A HREF="#author">AUTHOR</A></LI>
  33         <LI><A HREF="#see also">SEE ALSO</A></LI>
  34         <LI><A HREF="#bugs">BUGS</A></LI>
  35 </UL>
  36 <!-- INDEX END -->
  37
  38 <HR>
  39 <P>
  40 <H1><A NAME="name">NAME</A></H1>
  41 <P>FS - Freeside Perl modules</P>
  42 <P>
  43 <HR>
  44 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  45 <P>Freeside perl modules and CLI utilities.</P>
  46 <P>
  47 <H2><A NAME="utility classes">Utility classes</A></H2>
  48 <P><A HREF="././FS/Conf.html">the FS::Conf manpage</A> - Freeside configuration values</P>
  49 <P><A HREF="././FS/ConfItem.html">the FS::ConfItem manpage</A> - Freeside configuration option meta-data.</P>
  50 <P><A HREF="././FS/UID.html">the FS::UID manpage</A> - User class (not yet OO)</P>
  51 <P><A HREF="././FS/CGI.html">the FS::CGI manpage</A> - Non OO-subroutines for the web interface.</P>
  52 <P>
  53 <H2><A NAME="database record classes">Database record classes</A></H2>
  54 <P><A HREF="././FS/Record.html">the FS::Record manpage</A> - Database record base class</P>
  55 <P><A HREF="././FS/svc_acct_pop.html">the FS::svc_acct_pop manpage</A> - POP (Point of Presence, not Post
  56 Office Protocol) class</P>
  57 <P><A HREF="././FS/part_pop_local.html">the FS::part_pop_local manpage</A> - Local calling area class</P>
  58 <P><A HREF="././FS/part_referral.html">the FS::part_referral manpage</A> - Referral class</P>
  59 <P><A HREF="././FS/cust_main_county.html">the FS::cust_main_county manpage</A> - Locale (tax rate) class</P>
  60 <P><A HREF="././FS/svc_Common.html">the FS::svc_Common manpage</A> - Service base class</P>
  61 <P><A HREF="././FS/svc_acct.html">the FS::svc_acct manpage</A> - Account (shell, RADIUS, POP3) class</P>
  62 <P><A HREF="././FS/svc_domain.html">the FS::svc_domain manpage</A> - Domain class</P>
  63 <P><A HREF="././FS/domain_record.html">the FS::domain_record manpage</A> - DNS zone entries</P>
  64 <P><A HREF="././FS/svc_forward.html">the FS::svc_forward manpage</A> - Mail forwarding class</P>
  65 <P><A HREF="././FS/svc_acct_sm.html">the FS::svc_acct_sm manpage</A> - (Depreciated) Vitual mail alias class</P>
  66 <P><A HREF="././FS/svc_www.html">the FS::svc_www manpage</A> - Web virtual host class.</P>
  67 <P><A HREF="././FS/part_svc.html">the FS::part_svc manpage</A> - Service definition class</P>
  68 <P><A HREF="././FS/part_svc_column.html">the FS::part_svc_column manpage</A> - Column constraint class</P>
  69 <P><A HREF="././FS/part_export.html">the FS::part_export manpage</A> - External provisioning export class</P>
  70 <P><A HREF="././FS/part_export_option.html">the FS::part_export_option manpage</A> - Export option class</P>
  71 <P><A HREF="././FS/part_pkg.html">the FS::part_pkg manpage</A> - Package (billing item) definition class</P>
  72 <P><A HREF="././FS/pkg_svc.html">the FS::pkg_svc manpage</A> - Class linking package (billing item)
  73 definitions (see <A HREF="././FS/part_pkg.html">the FS::part_pkg manpage</A>) with service definitions
  74 (see <A HREF="././FS/part_svc.html">the FS::part_svc manpage</A>)</P>
  75 <P><A HREF="././FS/agent.html">the FS::agent manpage</A> - Agent (reseller) class</P>
  76 <P><A HREF="././FS/agent_type.html">the FS::agent_type manpage</A> - Agent type class</P>
  77 <P><A HREF="././FS/type_pkgs.html">the FS::type_pkgs manpage</A> - Class linking agent types (see
  78 <A HREF="././FS/agent_type.html">the FS::agent_type manpage</A>) with package (billing item) definitions
  79 (see <A HREF="././FS/part_pkg.html">the FS::part_pkg manpage</A>)</P>
  80 <P><A HREF="././FS/cust_svc.html">the FS::cust_svc manpage</A> - Service class</P>
  81 <P><A HREF="././FS/cust_pkg.html">the FS::cust_pkg manpage</A> - Package (billing item) class</P>
  82 <P><A HREF="././FS/cust_main.html">the FS::cust_main manpage</A> - Customer class</P>
  83 <P><A HREF="././FS/cust_main_invoice.html">the FS::cust_main_invoice manpage</A> - Invoice destination
  84 class</P>
  85 <P><A HREF="././FS/cust_bill.html">the FS::cust_bill manpage</A> - Invoice class</P>
  86 <P><A HREF="././FS/cust_bill_pkg.html">the FS::cust_bill_pkg manpage</A> - Invoice line item class</P>
  87 <P><A HREF="././FS/part_bill_event.html">the FS::part_bill_event manpage</A> - Invoice event definition class</P>
  88 <P><A HREF="././FS/cust_bill_event.html">the FS::cust_bill_event manpage</A> - Completed invoice event class</P>
  89 <P><A HREF="././FS/cust_pay.html">the FS::cust_pay manpage</A> - Payment class</P>
  90 <P><A HREF="././FS/cust_bill_pay.html">the FS::cust_bill_pay manpage</A> - Payment application class</P>
  91 <P><A HREF="././FS/cust_credit.html">the FS::cust_credit manpage</A> - Credit class</P>
  92 <P><A HREF="././FS/cust_refund.html">the FS::cust_refund manpage</A> - Refund class</P>
  93 <P><A HREF="././FS/cust_credit_refund.html">the FS::cust_credit_refund manpage</A> - Refund application class</P>
  94 <P><A HREF="././FS/cust_credit_bill.html">the FS::cust_credit_bill manpage</A> - Credit invoice application class</P>
  95 <P><A HREF="././FS/cust_pay_batch.html">the FS::cust_pay_batch manpage</A> - Credit card transaction queue class</P>
  96 <P><A HREF="././FS/prepay_credit.html">the FS::prepay_credit manpage</A> - Prepaid ``calling card'' credit class.</P>
  97 <P><A HREF="././FS/nas.html">the FS::nas manpage</A> - Network Access Server class</P>
  98 <P><A HREF="././FS/port.html">the FS::port manpage</A> - NAS port class</P>
  99 <P><A HREF="././FS/session.html">the FS::session manpage</A> - User login session class</P>
 100 <P><A HREF="././FS/queue.html">the FS::queue manpage</A> - Job queue</P>
 101 <P><A HREF="././FS/queue_arg.html">the FS::queue_arg manpage</A> - Job arguments</P>
 102 <P>
 103 <HR>
 104 <H1><A NAME="remote api modules">Remote API modules</A></H1>
 105 <P><A HREF="./FS/SignupClient.html">the FS::SignupClient manpage</A></P>
 106 <P><A HREF="./FS/SessionClient.html">the FS::SessionClient manpage</A></P>
 107 <P><A HREF="./FS/MailAdminServer.html">the FS::MailAdminServer manpage</A></P>
 108 <P>
 109 <H2><A NAME="commandline utilities">Command-line utilities</A></H2>
 110 <P><A HREF="././bin/freeside-email.html">the freeside-email manpage</A></P>
 111 <P><A HREF="././bin/freeside-queued.html">the freeside-queued manpage</A></P>
 112 <P><A HREF="././bin/freeside-adduser.html">the freeside-adduser manpage</A></P>
 113 <P><A HREF="././bin/freeside-bill.html">the freeside-bill manpage</A></P>
 114 <P><A HREF="././bin/freeside-overdue.html">the freeside-overdue manpage</A></P>
 115 <P>
 116 <H2><A NAME="user interface classes (under (stalled) development; not yet usable)">User Interface classes (under (stalled) development; not yet usable)</A></H2>
 117 <P><A HREF="././FS/UI/Base.html">the FS::UI::Base manpage</A> - User-interface base class</P>
 118 <P><A HREF="././FS/UI/Gtk.html">the FS::UI::Gtk manpage</A> - Gtk user-interface class</P>
 119 <P><A HREF="././FS/UI/CGI.html">the FS::UI::CGI manpage</A> - CGI (HTML) user-interface class</P>
 120 <P><A HREF="././FS/UI/agent.html">the FS::UI::agent manpage</A> - agent table user-interface class</P>
 121 <P>
 122 <H2><A NAME="notes">Notes</A></H2>
 123 <P>To quote perl(1), ``If you're intending to read these straight through for the
 124 first time, the suggested order will tend to reduce the number of forward
 125 references.''</P>
 126 <P>If you've never used OO modules before,
 127 <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>
 128 <P>
 129 <HR>
 130 <H1><A NAME="description">DESCRIPTION</A></H1>
 131 <P>Freeside is a billing and administration package for Internet Service
 132 Providers.</P>
 133 <P>The Freeside home page is at &lt;http://www.sisd.com/freeside&gt;.</P>
 134 <P>The main documentation is in httemplate/docs.</P>
 135 <P>
 136 <HR>
 137 <H1><A NAME="support">SUPPORT</A></H1>
 138 <P>A mailing list for users is available.  Send a blank message to
 139 &lt;<A HREF="mailto:ivan-freeside-subscribe@sisd.com">ivan-freeside-subscribe@sisd.com</A>&gt; to subscribe.</P>
 140 <P>A mailing list for developers is available.  It is intended to be lower volume
 141 and higher SNR than the users list.  Send a blank message to
 142 &lt;<A HREF="mailto:ivan-freeside-devel-subscribe@sisd.com">ivan-freeside-devel-subscribe@sisd.com</A>&gt; to subscribe.</P>
 143 <P>Commercial support is available; see
 144 &lt;http://www.sisd.com/freeside/commercial.html&gt;.</P>
 145 <P>
 146 <HR>
 147 <H1><A NAME="author">AUTHOR</A></H1>
 148 <P>Primarily Ivan Kohler &lt;<A HREF="mailto:ivan@sisd.com">ivan@sisd.com</A>&gt;, with help from many kind folks.</P>
 149 <P>See the CREDITS file in the Freeside distribution for a (hopefully) complete
 150 list and the individal files for details.</P>
 151 <P>
 152 <HR>
 153 <H1><A NAME="see also">SEE ALSO</A></H1>
 154 <P>perl(1), main Freeside documentation in htdocs/docs/</P>
 155 <P>
 156 <HR>
 157 <H1><A NAME="bugs">BUGS</A></H1>
 158 <P>Those modules which would be useful separately should be pulled out,
 159 renamed appropriately and uploaded to CPAN.  So far: DBIx::DBSchema, Net::SSH
 160 and Net::SCP...</P>
 161
 162 </BODY>
 163
 164 </HTML>