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 Freeside perl modules and CLI utilities.
  18
  19 =head2 Utility classes
  20
  21 L<FS::Conf> - Freeside configuration values
  22
  23 L<FS::ConfItem> - Freeside configuration option meta-data.
  24
  25 L<FS::UID> - User class (not yet OO)
  26
  27 L<FS::CGI> - Non OO-subroutines for the web interface.
  28
  29 =head2 Database record classes
  30
  31 L<FS::Record> - Database record base class
  32
  33 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
  34 Office Protocol) class
  35
  36 L<FS::part_pop_local> - Local calling area class
  37
  38 L<FS::part_referral> - Referral class
  39
  40 L<FS::cust_main_county> - Locale (tax rate) class
  41
  42 L<FS::svc_Common> - Service base class
  43
  44 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
  45
  46 L<FS::svc_domain> - Domain class
  47
  48 L<FS::domain_record> - DNS zone entries
  49
  50 L<FS::svc_forward> - Mail forwarding class
  51
  52 L<FS::svc_acct_sm> - (Depreciated) Vitual mail alias class
  53
  54 L<FS::svc_www> - Web virtual host class.
  55
  56 L<FS::part_svc> - Service definition class
  57
  58 L<FS::part_svc_column> - Column constraint class
  59
  60 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
  61 with exports (see L<FS::part_export>)
  62
  63 L<FS::part_export> - External provisioning export class
  64
  65 L<FS::part_export_option> - Export option 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::part_bill_event> - Invoice event definition class
  95
  96 L<FS::cust_bill_event> - Completed invoice event class
  97
  98 L<FS::cust_pay> - Payment class
  99
 100 L<FS::cust_bill_pay> - Payment application class
 101
 102 L<FS::cust_credit> - Credit class
 103
 104 L<FS::cust_refund> - Refund class
 105
 106 L<FS::cust_credit_refund> - Refund application class
 107
 108 L<FS::cust_credit_bill> - Credit invoice application class
 109
 110 L<FS::cust_pay_batch> - Credit card transaction queue class
 111
 112 L<FS::prepay_credit> - Prepaid "calling card" credit class.
 113
 114 L<FS::nas> - Network Access Server class
 115
 116 L<FS::port> - NAS port class
 117
 118 L<FS::session> - User login session class
 119
 120 L<FS::queue> - Job queue
 121
 122 L<FS::queue_arg> - Job arguments
 123
 124 =head1 Remote API modules
 125
 126 L<FS::SignupClient>
 127
 128 L<FS::SessionClient>
 129
 130 L<FS::MailAdminServer>
 131
 132 =head2 Command-line utilities
 133
 134 L<freeside-email>
 135
 136 L<freeside-queued>
 137
 138 L<freeside-adduser>
 139
 140 L<freeside-bill>
 141
 142 L<freeside-overdue>
 143
 144 =head2 User Interface classes (under (stalled) development; not yet usable)
 145
 146 L<FS::UI::Base> - User-interface base class
 147
 148 L<FS::UI::Gtk> - Gtk user-interface class
 149
 150 L<FS::UI::CGI> - CGI (HTML) user-interface class
 151
 152 L<FS::UI::agent> - agent table user-interface class
 153
 154 =head2 Notes
 155
 156 To quote perl(1), "If you're intending to read these straight through for the
 157 first time, the suggested order will tend to reduce the number of forward
 158 references."
 159
 160 If you've never used OO modules before,
 161 http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html might help you out.
 162
 163 =head1 DESCRIPTION
 164
 165 Freeside is a billing and administration package for Internet Service
 166 Providers.
 167
 168 The Freeside home page is at <http://www.sisd.com/freeside>.
 169
 170 The main documentation is in httemplate/docs.
 171
 172 =head1 SUPPORT
 173
 174 A mailing list for users is available.  Send a blank message to
 175 <ivan-freeside-subscribe@sisd.com> to subscribe.
 176
 177 A mailing list for developers is available.  It is intended to be lower volume
 178 and higher SNR than the users list.  Send a blank message to
 179 <ivan-freeside-devel-subscribe@sisd.com> to subscribe.
 180
 181 Commercial support is available; see
 182 <http://www.sisd.com/freeside/commercial.html>.
 183
 184 =head1 AUTHOR
 185
 186 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
 187
 188 See the CREDITS file in the Freeside distribution for a (hopefully) complete
 189 list and the individal files for details.
 190
 191 =head1 SEE ALSO
 192
 193 perl(1), main Freeside documentation in htdocs/docs/
 194
 195 =head1 BUGS
 196
 197 Those modules which would be useful separately should be pulled out,
 198 renamed appropriately and uploaded to CPAN.  So far: DBIx::DBSchema, Net::SSH
 199 and Net::SCP...
 200
 201 =cut
 202