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