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::part_export> - External provisioning export class
  61
  62 L<FS::part_export_option> - Export option class
  63
  64 L<FS::part_pkg> - Package (billing item) definition class
  65
  66 L<FS::pkg_svc> - Class linking package (billing item)
  67 definitions (see L<FS::part_pkg>) with service definitions
  68 (see L<FS::part_svc>)
  69
  70 L<FS::agent> - Agent (reseller) class
  71
  72 L<FS::agent_type> - Agent type class
  73
  74 L<FS::type_pkgs> - Class linking agent types (see
  75 L<FS::agent_type>) with package (billing item) definitions
  76 (see L<FS::part_pkg>)
  77
  78 L<FS::cust_svc> - Service class
  79
  80 L<FS::cust_pkg> - Package (billing item) class
  81
  82 L<FS::cust_main> - Customer class
  83
  84 L<FS::cust_main_invoice> - Invoice destination
  85 class
  86
  87 L<FS::cust_bill> - Invoice class
  88
  89 L<FS::cust_bill_pkg> - Invoice line item class
  90
  91 L<FS::part_bill_event> - Invoice event definition class
  92
  93 L<FS::cust_bill_event> - Completed invoice event class
  94
  95 L<FS::cust_pay> - Payment class
  96
  97 L<FS::cust_bill_pay> - Payment application class
  98
  99 L<FS::cust_credit> - Credit class
 100
 101 L<FS::cust_refund> - Refund class
 102
 103 L<FS::cust_credit_refund> - Refund application class
 104
 105 L<FS::cust_credit_bill> - Credit invoice application class
 106
 107 L<FS::cust_pay_batch> - Credit card transaction queue class
 108
 109 L<FS::prepay_credit> - Prepaid "calling card" credit class.
 110
 111 L<FS::nas> - Network Access Server class
 112
 113 L<FS::port> - NAS port class
 114
 115 L<FS::session> - User login session class
 116
 117 L<FS::queue> - Job queue
 118
 119 L<FS::queue_arg> - Job arguments
 120
 121 =head1 Remote API modules
 122
 123 L<FS::SignupClient>
 124
 125 L<FS::SessionClient>
 126
 127 L<FS::MailAdminServer>
 128
 129 =head2 Command-line utilities
 130
 131 L<freeside-email>
 132
 133 L<freeside-queued>
 134
 135 L<freeside-adduser>
 136
 137 L<freeside-bill>
 138
 139 L<freeside-overdue>
 140
 141 =head2 User Interface classes (under (stalled) development; not yet usable)
 142
 143 L<FS::UI::Base> - User-interface base class
 144
 145 L<FS::UI::Gtk> - Gtk user-interface class
 146
 147 L<FS::UI::CGI> - CGI (HTML) user-interface class
 148
 149 L<FS::UI::agent> - agent table user-interface class
 150
 151 =head2 Notes
 152
 153 To quote perl(1), "If you're intending to read these straight through for the
 154 first time, the suggested order will tend to reduce the number of forward
 155 references."
 156
 157 If you've never used OO modules before,
 158 http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html might help you out.
 159
 160 =head1 DESCRIPTION
 161
 162 Freeside is a billing and administration package for Internet Service
 163 Providers.
 164
 165 The Freeside home page is at <http://www.sisd.com/freeside>.
 166
 167 The main documentation is in httemplate/docs.
 168
 169 =head1 SUPPORT
 170
 171 A mailing list for users is available.  Send a blank message to
 172 <ivan-freeside-subscribe@sisd.com> to subscribe.
 173
 174 A mailing list for developers is available.  It is intended to be lower volume
 175 and higher SNR than the users list.  Send a blank message to
 176 <ivan-freeside-devel-subscribe@sisd.com> to subscribe.
 177
 178 Commercial support is available; see
 179 <http://www.sisd.com/freeside/commercial.html>.
 180
 181 =head1 AUTHOR
 182
 183 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
 184
 185 See the CREDITS file in the Freeside distribution for a (hopefully) complete
 186 list and the individal files for details.
 187
 188 =head1 SEE ALSO
 189
 190 perl(1), main Freeside documentation in htdocs/docs/
 191
 192 =head1 BUGS
 193
 194 Those modules which would be useful separately should be pulled out,
 195 renamed appropriately and uploaded to CPAN.  So far: DBIx::DBSchema, Net::SSH
 196 and Net::SCP...
 197
 198 =cut
 199