FS/FS.pm

   1 package FS;
   2
   3 use strict;
   4 use vars qw($VERSION);
   5
   6 $VERSION = '0.01';
   7
   8 #find missing entries in this file with:
   9 # for a in `ls *pm | cut -d. -f1`; do grep 'L<FS::'$a'>' ../FS.pm >/dev/null || echo "missing $a" ; done
  10
  11 1;
  12 __END__
  13
  14 =head1 NAME
  15
  16 FS - Freeside Perl modules
  17
  18 =head1 SYNOPSIS
  19
  20 Freeside perl modules and CLI utilities.
  21
  22 =head2 Utility classes
  23
  24 L<FS::Conf> - Freeside configuration values
  25
  26 L<FS::ConfItem> - Freeside configuration option meta-data.
  27
  28 L<FS::UID> - User class (not yet OO)
  29
  30 L<FS::CGI> - Non OO-subroutines for the web interface.
  31
  32 L<FS::Msgcat> - Message catalog
  33
  34 L<FS::SearchCache> - Search cache
  35
  36 L<FS::raddb> - RADIUS dictionary
  37
  38 =head2 Database record classes
  39
  40 L<FS::Record> - Database record base class
  41
  42 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
  43 Office Protocol) class
  44
  45 L<FS::part_pop_local> - Local calling area class
  46
  47 L<FS::part_referral> - Referral class
  48
  49 L<FS::cust_main_county> - Locale (tax rate) class
  50
  51 L<FS::cust_tax_exempt> - Tax exemption record class
  52
  53 L<FS::svc_Common> - Service base class
  54
  55 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
  56
  57 L<FS::acct_snarf> - External mail account class
  58
  59 L<FS::radius_usergroup> - RADIUS groups
  60
  61 L<FS::svc_domain> - Domain class
  62
  63 L<FS::domain_record> - DNS zone entries
  64
  65 L<FS::svc_forward> - Mail forwarding class
  66
  67 L<FS::svc_www> - Web virtual host class.
  68
  69 L<FS::svc_broadband> - DSL, wireless and other broadband class.
  70
  71 L<FS::svc_external> - Externally tracked service class.
  72
  73 L<FS::part_svc> - Service definition class
  74
  75 L<FS::part_svc_column> - Column constraint class
  76
  77 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
  78 with exports (see L<FS::part_export>)
  79
  80 L<FS::part_export> - External provisioning export class
  81
  82 L<FS::part_export_option> - Export option class
  83
  84 L<FS::part_pkg> - Package (billing item) definition class
  85
  86 L<FS::pkg_svc> - Class linking package (billing item)
  87 definitions (see L<FS::part_pkg>) with service definitions
  88 (see L<FS::part_svc>)
  89
  90 L<FS::agent> - Agent (reseller) class
  91
  92 L<FS::agent_type> - Agent type class
  93
  94 L<FS::type_pkgs> - Class linking agent types (see
  95 L<FS::agent_type>) with package (billing item) definitions
  96 (see L<FS::part_pkg>)
  97
  98 L<FS::cust_svc> - Service class
  99
 100 L<FS::cust_pkg> - Package (billing item) class
 101
 102 L<FS::cust_main> - Customer class
 103
 104 L<FS::cust_main_invoice> - Invoice destination
 105 class
 106
 107 L<FS::cust_bill> - Invoice class
 108
 109 L<FS::cust_bill_pkg> - Invoice line item class
 110
 111 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
 112
 113 L<FS::part_bill_event> - Invoice event definition class
 114
 115 L<FS::cust_bill_event> - Completed invoice event class
 116
 117 L<FS::cust_pay> - Payment class
 118
 119 L<FS::cust_bill_pay> - Payment application class
 120
 121 L<FS::cust_credit> - Credit class
 122
 123 L<FS::cust_refund> - Refund class
 124
 125 L<FS::cust_credit_refund> - Refund application to credit class
 126
 127 L<FS::cust_credit_bill> - Credit application to invoice class
 128
 129 L<FS::cust_pay_refund> - Refund application to payment class
 130
 131 L<FS::cust_pay_batch> - Credit card transaction queue class
 132
 133 L<FS::prepay_credit> - Prepaid "calling card" credit class.
 134
 135 L<FS::nas> - Network Access Server class
 136
 137 L<FS::port> - NAS port class
 138
 139 L<FS::session> - User login session class
 140
 141 L<FS::queue> - Job queue
 142
 143 L<FS::queue_arg> - Job arguments
 144
 145 L<FS::queue_depend> - Job dependencies
 146
 147 L<FS::msgcat> - Message catalogs
 148
 149 =head1 Remote API modules
 150
 151 L<FS::SelfService>
 152
 153 L<FS::SignupClient>
 154
 155 L<FS::SessionClient>
 156
 157 L<FS::MailAdminServer> (deprecated in favor of the self-service server)
 158
 159 =head2 Command-line utilities
 160
 161 L<freeside-adduser>
 162
 163 L<freeside-queued>
 164
 165 L<freeside-daily>
 166
 167 L<freeside-expiration-alerter>
 168
 169 L<freeside-email>
 170
 171 L<freeside-cc-receipts-report>
 172
 173 L<freeside-credit-report>
 174
 175 L<freeside-receivables-report>
 176
 177 L<freeside-tax-report>
 178
 179 L<freeside-bill>
 180
 181 L<freeside-overdue>
 182
 183 =head2 User Interface classes (under (stalled) development; not yet usable)
 184
 185 L<FS::UI::Base> - User-interface base class
 186
 187 L<FS::UI::Gtk> - Gtk user-interface class
 188
 189 L<FS::UI::CGI> - CGI (HTML) user-interface class
 190
 191 L<FS::UI::agent> - agent table user-interface class
 192
 193 =head2 Notes
 194
 195 To quote perl(1), "If you're intending to read these straight through for the
 196 first time, the suggested order will tend to reduce the number of forward
 197 references."
 198
 199 If you've never used OO modules before,
 200 http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
 201
 202 =head1 DESCRIPTION
 203
 204 Freeside is a billing and administration package for Internet Service
 205 Providers.
 206
 207 The Freeside home page is at <http://www.sisd.com/freeside>.
 208
 209 The main documentation is in httemplate/docs.
 210
 211 =head1 SUPPORT
 212
 213 A mailing list for users is available.  Send a blank message to
 214 <ivan-freeside-subscribe@sisd.com> to subscribe.
 215
 216 A mailing list for developers is available.  It is intended to be lower volume
 217 and higher SNR than the users list.  Send a blank message to
 218 <ivan-freeside-devel-subscribe@sisd.com> to subscribe.
 219
 220 Commercial support is available; see
 221 <http://www.sisd.com/freeside/commercial.html>.
 222
 223 =head1 AUTHOR
 224
 225 Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
 226
 227 See the CREDITS file in the Freeside distribution for a (hopefully) complete
 228 list and the individal files for details.
 229
 230 =head1 SEE ALSO
 231
 232 perl(1), main Freeside documentation in htdocs/docs/
 233
 234 =head1 BUGS
 235
 236 Those modules which would be useful separately should be pulled out,
 237 renamed appropriately and uploaded to CPAN.  So far: DBIx::DBSchema, Net::SSH
 238 and Net::SCP...
 239
 240 =cut
 241