FS/FS.pm

   1 package FS;
   2
   3 use strict;
   4 use vars qw($VERSION);
   5
   6 $VERSION = '0.01';
   7
   8 1;
   9 __END__
  10
  11 =head1 NAME
  12
  13 FS - Freeside Perl modules
  14
  15 =head1 SYNOPSIS
  16
  17 FS is the unofficial (i.e. non-CPAN) prefix for the Perl module portion of the
  18 Freeside ISP billing software.  This includes:
  19
  20 =head2 Utility classes
  21
  22 L<FS::Conf> - Freeside configuration values
  23
  24 L<FS::ConfItem> - Freeside configuration option meta-data.
  25
  26 L<FS::UID> - User class (not yet OO)
  27
  28 L<FS::CGI> - Non OO-subroutines for the web interface.  This is
  29 depriciated.  Future development will be focused on the FS::UI user-interface
  30 classes (see below).
  31
  32 =head2 Database record classes
  33
  34 L<FS::Record> - Database record base class
  35
  36 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
  37 Office Protocol) class
  38
  39 L<FS::part_pop_local> - Local calling area class
  40
  41 L<FS::part_referral> - Referral class
  42
  43 L<FS::cust_main_county> - Locale (tax rate) class
  44
  45 L<FS::svc_Common> - Service base class
  46
  47 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
  48
  49 L<FS::svc_domain> - Domain class
  50
  51 L<FS::domain_record> - DNS zone entries
  52
  53 L<FS::svc_forward> - Mail forwarding class
  54
  55 L<FS::svc_acct_sm> - (Depreciated) Vitual mail alias class
  56
  57 L<FS::svc_www> - Web virtual host class.
  58
  59 L<FS::part_svc> - Service definition class
  60
  61 L<FS::part_svc_column> - Column constraint class
  62
  63 L<FS::part_pkg> - Package (billing item) definition class
  64
  65 L<FS::pkg_svc> - Class linking package (billing item)
  66 definitions (see L<FS::part_pkg>) with service definitions
  67 (see L<FS::part_svc>)
  68
  69 L<FS::agent> - Agent (reseller) class
  70
  71 L<FS::agent_type> - Agent type class
  72
  73 L<FS::type_pkgs> - Class linking agent types (see
  74 L<FS::agent_type>) with package (billing item) definitions
  75 (see L<FS::part_pkg>)
  76
  77 L<FS::cust_svc> - Service class
  78
  79 L<FS::cust_pkg> - Package (billing item) class
  80
  81 L<FS::cust_main> - Customer class
  82
  83 L<FS::cust_main_invoice> - Invoice destination
  84 class
  85
  86 L<FS::cust_bill> - Invoice class
  87
  88 L<FS::cust_bill_pkg> - Invoice line item class
  89
  90 L<FS::cust_pay> - Payment class
  91
  92 L<FS::cust_bill_pay> - Payment application class
  93
  94 L<FS::cust_credit> - Credit class
  95
  96 L<FS::cust_refund> - Refund class
  97
  98 L<FS::cust_credit_refund> - Refund application class
  99
 100 L<FS::cust_credit_bill> - Credit invoice application class
 101
 102 L<FS::cust_pay_batch> - Credit card transaction queue class
 103
 104 L<FS::prepay_credit> - Prepaid "calling card" credit class.
 105
 106 L<FS::nas> - Network Access Server class
 107
 108 L<FS::port> - NAS port class
 109
 110 L<FS::session> - User login session class
 111
 112 L<FS::queue> - Job queue
 113
 114 L<FS::queue_arg> - Job arguments
 115
 116 =head2 User Interface classes (under development; not yet usable)
 117
 118 L<FS::UI::Base> - User-interface base class
 119
 120 L<FS::UI::Gtk> - Gtk user-interface class
 121
 122 L<FS::UI::CGI> - CGI (HTML) user-interface class
 123
 124 L<FS::UI::agent> - agent table user-interface class
 125
 126 =head2 Notes
 127
 128 To quote perl(1), "If you're intending to read these straight through for the
 129 first time, the suggested order will tend to reduce the number of forward
 130 references."
 131
 132 If you've never used OO modules before,
 133 http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html might help you out.
 134
 135 =head1 DESCRIPTION
 136
 137 Freeside is a billing and administration package for Internet Service
 138 Providers.
 139
 140 The Freeside home page is at <http://www.sisd.com/freeside>.
 141
 142 The main documentation is in htdocs/docs.
 143
 144 =head1 VERSION
 145
 146 $Id: FS.pm,v 1.10 2001-10-24 15:29:30 ivan Exp $
 147
 148 =head1 SUPPORT
 149
 150 A mailing list for users and developers is available.  Send a blank message to
 151 <ivan-freeside-subscribe@sisd.com> to subscribe.
 152
 153 Commercial support is available; see
 154 <http://www.sisd.com/freeside/commercial.html>.
 155
 156 =head1 AUTHOR
 157
 158 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
 159
 160 See the CREDITS file in the Freeside distribution for a (hopefully) complete
 161 list and the individal files for details.
 162
 163 =head1 SEE ALSO
 164
 165 perl(1), main Freeside documentation in htdocs/docs/
 166
 167 =head1 BUGS
 168
 169 The version number of the FS Perl extension differs from the version of the
 170 Freeside distribution, which are both different from the CVS version tag for
 171 each file, which appears under the VERSION heading.
 172
 173 Those modules which would be useful separately should be pulled out,
 174 renamed appropriately and uploaded to CPAN.  So far: DBIx::DBSchema, Net::SSH
 175 and Net::SCP...
 176
 177 =cut
 178