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::svc_acct_sm> - Vitual mail alias class
  48
  49 L<FS::part_svc> - Service definition class
  50
  51 L<FS::part_pkg> - Package (billing item) definition class
  52
  53 L<FS::pkg_svc> - Class linking package (billing item)
  54 definitions (see L<FS::part_pkg>) with service definitions
  55 (see L<FS::part_svc>)
  56
  57 L<FS::agent> - Agent (reseller) class
  58
  59 L<FS::agent_type> - Agent type class
  60
  61 L<FS::type_pkgs> - Class linking agent types (see
  62 L<FS::agent_type>) with package (billing item) definitions
  63 (see L<FS::part_pkg>)
  64
  65 L<FS::cust_svc> - Service class
  66
  67 L<FS::cust_pkg> - Package (billing item) class
  68
  69 L<FS::cust_main> - Customer class
  70
  71 L<FS::cust_main_invoice> - Invoice destination
  72 class
  73
  74 L<FS::cust_bill> - Invoice class
  75
  76 L<FS::cust_bill_pkg> - Invoice line item class
  77
  78 L<FS::cust_pay> - Payment class
  79
  80 L<FS::cust_credit> - Credit class
  81
  82 L<FS::cust_refund> - Refund class
  83
  84 L<FS::cust_pay_batch> - Credit card transaction queue
  85 class
  86
  87 =head2 User Interface classes (under development; not yet usable)
  88
  89 L<FS::UI::Base> - User-interface base class
  90
  91 L<FS::UI::Gtk> - Gtk user-interface class
  92
  93 L<FS::UI::CGI> - CGI (HTML) user-interface class
  94
  95 L<FS::UI::agent> - agent table user-interface class
  96
  97 =head2 Notes
  98
  99 To quote perl(1), "If you're intending to read these straight through for the
 100 first time, the suggested order will tend to reduce the number of forward
 101 references."
 102
 103 =head1 DESCRIPTION
 104
 105 Freeside is a billing and administration package for Internet Service
 106 Providers.
 107
 108 The Freeside home page is at <http://www.sisd.com/freeside>.
 109
 110 The main documentation is in htdocs/docs.
 111
 112 =head1 VERSION
 113
 114 $Id: FS.pm,v 1.4 2001-04-22 01:56:14 ivan Exp $
 115
 116 =head1 SUPPORT
 117
 118 A mailing list for users and developers is available.  Send a blank message to
 119 <ivan-freeside-subscribe@sisd.com> to subscribe.
 120
 121 Commercial support is available; see
 122 <http://www.sisd.com/freeside/commercial.html>.
 123
 124 =head1 AUTHOR
 125
 126 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
 127
 128 See the CREDITS file in the Freeside distribution for a (hopefully) complete
 129 list and the individal files for details.
 130
 131 =head1 SEE ALSO
 132
 133 perl(1), main Freeside documentation in htdocs/docs/
 134
 135 =head1 BUGS
 136
 137 The version number of the FS Perl extension differs from the version of the
 138 Freeside distribution, which are both different from the CVS version tag for
 139 each file, which appears under the VERSION heading.
 140
 141 Those modules which would be useful separately should be pulled out,
 142 renamed appropriately and uploaded to CPAN.  So far: DBIx::DBSchema, Net::SSH
 143 and Net::SCP...
 144
 145 =cut
 146