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::UID> - User class (not yet OO)
  25
  26 L<FS::CGI> - Non OO-subroutines for the web interface.  This is
  27 depriciated.  Future development will be focused on the FS::UI user-interface
  28 classes (see below).
  29
  30 =head2 Database record classes
  31
  32 L<FS::Record> - Database record base class
  33
  34 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
  35 Office Protocol) class
  36
  37 L<FS::part_referral> - Referral class
  38
  39 L<FS::cust_main_county> - Locale (tax rate) class
  40
  41 L<FS::svc_Common> - Service base class
  42
  43 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
  44
  45 L<FS::svc_domain> - Domain class
  46
  47 L<FS::domain_record> - DNS zone entries
  48
  49 L<FS::svc_acct_sm> - Vitual mail alias class
  50
  51 L<FS::svc_www> - Web virtual host class.
  52
  53 L<FS::part_svc> - Service definition class
  54
  55 L<FS::part_pkg> - Package (billing item) definition class
  56
  57 L<FS::pkg_svc> - Class linking package (billing item)
  58 definitions (see L<FS::part_pkg>) with service definitions
  59 (see L<FS::part_svc>)
  60
  61 L<FS::agent> - Agent (reseller) class
  62
  63 L<FS::agent_type> - Agent type class
  64
  65 L<FS::type_pkgs> - Class linking agent types (see
  66 L<FS::agent_type>) with package (billing item) definitions
  67 (see L<FS::part_pkg>)
  68
  69 L<FS::cust_svc> - Service class
  70
  71 L<FS::cust_pkg> - Package (billing item) class
  72
  73 L<FS::cust_main> - Customer class
  74
  75 L<FS::cust_main_invoice> - Invoice destination
  76 class
  77
  78 L<FS::cust_bill> - Invoice class
  79
  80 L<FS::cust_bill_pkg> - Invoice line item class
  81
  82 L<FS::cust_pay> - Payment class
  83
  84 L<FS::cust_bill_pay> - Payment application class
  85
  86 L<FS::cust_credit> - Credit class
  87
  88 L<FS::cust_refund> - Refund class
  89
  90 L<FS::cust_credit_refund> - Refund application class
  91
  92 L<FS::cust_credit_bill> - Refund invoice application class
  93
  94 L<FS::cust_pay_batch> - Credit card transaction queue class
  95
  96 L<FS::prepay_credit> - Prepaid "calling card" credit class.
  97
  98 L<FS::nas> - Network Access Server class
  99
 100 L<FS::port> - NAS port class
 101
 102 L<FS::session> - User login session class
 103
 104 =head2 User Interface classes (under development; not yet usable)
 105
 106 L<FS::UI::Base> - User-interface base class
 107
 108 L<FS::UI::Gtk> - Gtk user-interface class
 109
 110 L<FS::UI::CGI> - CGI (HTML) user-interface class
 111
 112 L<FS::UI::agent> - agent table user-interface class
 113
 114 =head2 Notes
 115
 116 To quote perl(1), "If you're intending to read these straight through for the
 117 first time, the suggested order will tend to reduce the number of forward
 118 references."
 119
 120 =head1 DESCRIPTION
 121
 122 Freeside is a billing and administration package for Internet Service
 123 Providers.
 124
 125 The Freeside home page is at <http://www.sisd.com/freeside>.
 126
 127 The main documentation is in htdocs/docs.
 128
 129 =head1 VERSION
 130
 131 $Id: FS.pm,v 1.6 2001-09-02 04:25:55 ivan Exp $
 132
 133 =head1 SUPPORT
 134
 135 A mailing list for users and developers is available.  Send a blank message to
 136 <ivan-freeside-subscribe@sisd.com> to subscribe.
 137
 138 Commercial support is available; see
 139 <http://www.sisd.com/freeside/commercial.html>.
 140
 141 =head1 AUTHOR
 142
 143 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
 144
 145 See the CREDITS file in the Freeside distribution for a (hopefully) complete
 146 list and the individal files for details.
 147
 148 =head1 SEE ALSO
 149
 150 perl(1), main Freeside documentation in htdocs/docs/
 151
 152 =head1 BUGS
 153
 154 The version number of the FS Perl extension differs from the version of the
 155 Freeside distribution, which are both different from the CVS version tag for
 156 each file, which appears under the VERSION heading.
 157
 158 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...
 161
 162 =cut
 163