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 temporary prefix for many disparate modules written for the Freeside
  18 ISP billing software.  This includes:
  19
  20 =head2 Database metadata classes
  21
  22 =over 4
  23
  24 =item L<FS::dbdef|FS::dbdef> - Database class
  25
  26 =item L<FS::dbdef_table|FS::dbdef_table> - Database table class
  27
  28 =item L<FS::dbdef_column|FS::dbdef_column> - Database column class
  29
  30 =item L<FS::dbdef_colgroup|FS::dbdef_colgroup> - Database column group class
  31
  32 =item L<FS::dbdef_index|FS::dbdef_index> - Database index class
  33
  34 =item L<FS::dbdef_unique|FS::dbdef_unique> - Database unique index class
  35
  36 =back
  37
  38 =head2 Utility classes
  39
  40 =over 4
  41
  42 =item L<FS::SSH|FS::SSH> - Simple wrappers around ssh and scp commands.
  43
  44 =item L<FS::Conf|FS::Conf> - Freeside configuration values
  45
  46 =item L<FS::UID|FS::UID> - User class (not yet OO)
  47
  48 =item L<FS::CGI|FS::CGI> - Non OO-subroutines for the web interface.  This is
  49 depriciated.  Future development will be focused on the FS::UI user-interface
  50 classes (see below).
  51
  52 =back
  53
  54 =head2 Database record classes
  55
  56 =over 4
  57
  58 =item L<FS::Record|FS::Record> - Database record base class
  59
  60 =item L<FS::svc_acct_pop|FS::svc_acct_pop> - POP (Point of Presence, not Post
  61 Office Protocol) class
  62
  63 =item L<FS::part_referral|FS::part_referral> - Referral class
  64
  65 =item L<FS::cust_main_county|FS::cust_main_county> - Locale (tax rate) class
  66
  67 =item L<FS::svc_Common|FS::svc_Common> - Service base class
  68
  69 =item L<FS::svc_acct|FS::svc_acct> - Account (shell, RADIUS, POP3) class
  70
  71 =item L<FS::svc_domain|FS::svc_domain> - Domain class
  72
  73 =item L<FS::svc_acct_sm|FS::svc_acct_sm> - Vitual mail alias class
  74
  75 =item L<FS::part_svc|FS::part_svc> - Service definition class
  76
  77 =item L<FS::part_pkg|FS::part_pkg> - Package (billing item) definition class
  78
  79 =item L<FS::pkg_svc|FS::pkg_svc> - Class linking package (billing item)
  80 definitions (see L<FS::part_pkg>) with service definitions
  81 (see L<FS::part_svc>)
  82
  83 =item L<FS::agent|FS::agent> - Agent (reseller) class
  84
  85 =item L<FS::agent_type|FS::agent_type> - Agent type class
  86
  87 =item L<FS::type_pkgs|FS::type_pkgs> - Class linking agent types (see
  88 L<FS::agent_type>) with package (billing item) definitions
  89 (see L<FS::part_pkg>)
  90
  91 =item L<FS::cust_svc|FS::cust_svc> - Service class
  92
  93 =item L<FS::cust_pkg|FS::cust_pkg> - Package (billing item) class
  94
  95 =item L<FS::cust_main|FS::cust_main> - Customer class
  96
  97 =item L<FS::cust_main_invoice|FS::cust_main_invoice> - Invoice destination
  98 class
  99
 100 =item L<FS::cust_bill|FS::cust_bill> - Invoice class
 101
 102 =item L<FS::cust_bill_pkg|FS::cust_bill_pkg> - Invoice line item class
 103
 104 =item L<FS::cust_pay|FS::cust_pay> - Payment class
 105
 106 =item L<FS::cust_credit|FS::cust_credit> - Credit class
 107
 108 =item L<FS::cust_refund|FS::cust_refund> - Refund class
 109
 110 =item L<FS::cust_pay_batch|FS::cust_pay_batch> - Credit card transaction queue
 111 class
 112
 113 =back
 114
 115 =head2 User Interface classes (under development; not yet usable)
 116
 117 =over 4
 118
 119 =item L<FS::UI::Base|FS::UI::Base> - User-interface base class
 120
 121 =item L<FS::UI::Gtk|FS::UI::Gtk> - Gtk user-interface class
 122
 123 =item L<FS::UI::CGI|FS::UI::CGI> - CGI (HTML) user-interface class
 124
 125 =item L<FS::UI::agent|FS::UI::agent> - agent table user-interface class
 126
 127 =back
 128
 129 To quote perl(1), "If you're intending to read these straight through for the
 130 first time, the suggested order will tend to reduce the number of forward
 131 references."
 132
 133 =head1 DESCRIPTION
 134
 135 Freeside is a billing and administration package for Internet Service
 136 Providers.
 137
 138 The Freeside home page is at <http://www.sisd.com/freeside>.
 139
 140 The main documentation is in htdocs/docs.
 141
 142 =head1 VERSION
 143
 144 $Id: FS.pm,v 1.2 1999-08-04 07:34:15 ivan Exp $
 145
 146 =head1 SUPPORT
 147
 148 A mailing list for users and developers is available.  Send a blank message to
 149 <ivan-freeside-subscribe@sisd.com> to subscribe.
 150
 151 Commercial support is available; see
 152 <http://www.sisd.com/freeside/commercial.html>.
 153
 154 =head1 AUTHOR
 155
 156 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
 157
 158 See the CREDITS file in the Freeside distribution for a (hopefully) complete
 159 list and the individal files for details.
 160
 161 =head1 SEE ALSO
 162
 163 perl(1), main Freeside documentation in htdocs/docs/
 164
 165 =head1 BUGS
 166
 167 The version number of the FS Perl extension differs from the version of the
 168 Freeside distribution, which are both different from the CVS version tag for
 169 each file, which appears under the VERSION heading.
 170
 171 Those modules which would be useful separately should be pulled out,
 172 renamed appropriately and uploaded to CPAN.
 173
 174 =cut
 175