blob: 7db6bb9fdfb8da99dd254ce32015024be4f3022a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
<HTML>
<HEAD>
<TITLE>FS - Freeside Perl modules</TITLE>
<LINK REV="made" HREF="mailto:perl@packages.debian.org">
</HEAD>
<BODY>
<A NAME="__index__"></A>
<!-- INDEX BEGIN -->
<UL>
<LI><A HREF="#name">NAME</A></LI>
<LI><A HREF="#synopsis">SYNOPSIS</A></LI>
<UL>
<LI><A HREF="#utility classes">Utility classes</A></LI>
<LI><A HREF="#database record classes">Database record classes</A></LI>
</UL>
<LI><A HREF="#remote api modules">Remote API modules</A></LI>
<UL>
<LI><A HREF="#commandline utilities">Command-line utilities</A></LI>
<LI><A HREF="#user interface classes (under (stalled) development; not yet usable)">User Interface classes (under (stalled) development; not yet usable)</A></LI>
<LI><A HREF="#notes">Notes</A></LI>
</UL>
<LI><A HREF="#description">DESCRIPTION</A></LI>
<LI><A HREF="#support">SUPPORT</A></LI>
<LI><A HREF="#author">AUTHOR</A></LI>
<LI><A HREF="#see also">SEE ALSO</A></LI>
<LI><A HREF="#bugs">BUGS</A></LI>
</UL>
<!-- INDEX END -->
<HR>
<P>
<H1><A NAME="name">NAME</A></H1>
<P>FS - Freeside Perl modules</P>
<P>
<HR>
<H1><A NAME="synopsis">SYNOPSIS</A></H1>
<P>Freeside perl modules and CLI utilities.</P>
<P>
<H2><A NAME="utility classes">Utility classes</A></H2>
<P><A HREF="././FS/Conf.html">the FS::Conf manpage</A> - Freeside configuration values</P>
<P><A HREF="././FS/ConfItem.html">the FS::ConfItem manpage</A> - Freeside configuration option meta-data.</P>
<P><A HREF="././FS/UID.html">the FS::UID manpage</A> - User class (not yet OO)</P>
<P><A HREF="././FS/CGI.html">the FS::CGI manpage</A> - Non OO-subroutines for the web interface.</P>
<P>
<H2><A NAME="database record classes">Database record classes</A></H2>
<P><A HREF="././FS/Record.html">the FS::Record manpage</A> - Database record base class</P>
<P><A HREF="././FS/svc_acct_pop.html">the FS::svc_acct_pop manpage</A> - POP (Point of Presence, not Post
Office Protocol) class</P>
<P><A HREF="././FS/part_pop_local.html">the FS::part_pop_local manpage</A> - Local calling area class</P>
<P><A HREF="././FS/part_referral.html">the FS::part_referral manpage</A> - Referral class</P>
<P><A HREF="././FS/cust_main_county.html">the FS::cust_main_county manpage</A> - Locale (tax rate) class</P>
<P><A HREF="././FS/svc_Common.html">the FS::svc_Common manpage</A> - Service base class</P>
<P><A HREF="././FS/svc_acct.html">the FS::svc_acct manpage</A> - Account (shell, RADIUS, POP3) class</P>
<P><A HREF="././FS/svc_domain.html">the FS::svc_domain manpage</A> - Domain class</P>
<P><A HREF="././FS/domain_record.html">the FS::domain_record manpage</A> - DNS zone entries</P>
<P><A HREF="././FS/svc_forward.html">the FS::svc_forward manpage</A> - Mail forwarding class</P>
<P><A HREF="././FS/svc_acct_sm.html">the FS::svc_acct_sm manpage</A> - (Depreciated) Vitual mail alias class</P>
<P><A HREF="././FS/svc_www.html">the FS::svc_www manpage</A> - Web virtual host class.</P>
<P><A HREF="././FS/part_svc.html">the FS::part_svc manpage</A> - Service definition class</P>
<P><A HREF="././FS/part_svc_column.html">the FS::part_svc_column manpage</A> - Column constraint class</P>
<P><A HREF="././FS/part_export.html">the FS::part_export manpage</A> - External provisioning export class</P>
<P><A HREF="././FS/part_export_option.html">the FS::part_export_option manpage</A> - Export option class</P>
<P><A HREF="././FS/part_pkg.html">the FS::part_pkg manpage</A> - Package (billing item) definition class</P>
<P><A HREF="././FS/pkg_svc.html">the FS::pkg_svc manpage</A> - Class linking package (billing item)
definitions (see <A HREF="././FS/part_pkg.html">the FS::part_pkg manpage</A>) with service definitions
(see <A HREF="././FS/part_svc.html">the FS::part_svc manpage</A>)</P>
<P><A HREF="././FS/agent.html">the FS::agent manpage</A> - Agent (reseller) class</P>
<P><A HREF="././FS/agent_type.html">the FS::agent_type manpage</A> - Agent type class</P>
<P><A HREF="././FS/type_pkgs.html">the FS::type_pkgs manpage</A> - Class linking agent types (see
<A HREF="././FS/agent_type.html">the FS::agent_type manpage</A>) with package (billing item) definitions
(see <A HREF="././FS/part_pkg.html">the FS::part_pkg manpage</A>)</P>
<P><A HREF="././FS/cust_svc.html">the FS::cust_svc manpage</A> - Service class</P>
<P><A HREF="././FS/cust_pkg.html">the FS::cust_pkg manpage</A> - Package (billing item) class</P>
<P><A HREF="././FS/cust_main.html">the FS::cust_main manpage</A> - Customer class</P>
<P><A HREF="././FS/cust_main_invoice.html">the FS::cust_main_invoice manpage</A> - Invoice destination
class</P>
<P><A HREF="././FS/cust_bill.html">the FS::cust_bill manpage</A> - Invoice class</P>
<P><A HREF="././FS/cust_bill_pkg.html">the FS::cust_bill_pkg manpage</A> - Invoice line item class</P>
<P><A HREF="././FS/part_bill_event.html">the FS::part_bill_event manpage</A> - Invoice event definition class</P>
<P><A HREF="././FS/cust_bill_event.html">the FS::cust_bill_event manpage</A> - Completed invoice event class</P>
<P><A HREF="././FS/cust_pay.html">the FS::cust_pay manpage</A> - Payment class</P>
<P><A HREF="././FS/cust_bill_pay.html">the FS::cust_bill_pay manpage</A> - Payment application class</P>
<P><A HREF="././FS/cust_credit.html">the FS::cust_credit manpage</A> - Credit class</P>
<P><A HREF="././FS/cust_refund.html">the FS::cust_refund manpage</A> - Refund class</P>
<P><A HREF="././FS/cust_credit_refund.html">the FS::cust_credit_refund manpage</A> - Refund application class</P>
<P><A HREF="././FS/cust_credit_bill.html">the FS::cust_credit_bill manpage</A> - Credit invoice application class</P>
<P><A HREF="././FS/cust_pay_batch.html">the FS::cust_pay_batch manpage</A> - Credit card transaction queue class</P>
<P><A HREF="././FS/prepay_credit.html">the FS::prepay_credit manpage</A> - Prepaid ``calling card'' credit class.</P>
<P><A HREF="././FS/nas.html">the FS::nas manpage</A> - Network Access Server class</P>
<P><A HREF="././FS/port.html">the FS::port manpage</A> - NAS port class</P>
<P><A HREF="././FS/session.html">the FS::session manpage</A> - User login session class</P>
<P><A HREF="././FS/queue.html">the FS::queue manpage</A> - Job queue</P>
<P><A HREF="././FS/queue_arg.html">the FS::queue_arg manpage</A> - Job arguments</P>
<P>
<HR>
<H1><A NAME="remote api modules">Remote API modules</A></H1>
<P><A HREF="./FS/SignupClient.html">the FS::SignupClient manpage</A></P>
<P><A HREF="./FS/SessionClient.html">the FS::SessionClient manpage</A></P>
<P><A HREF="./FS/MailAdminServer.html">the FS::MailAdminServer manpage</A></P>
<P>
<H2><A NAME="commandline utilities">Command-line utilities</A></H2>
<P><A HREF="././bin/freeside-email.html">the freeside-email manpage</A></P>
<P><A HREF="././bin/freeside-queued.html">the freeside-queued manpage</A></P>
<P><A HREF="././bin/freeside-adduser.html">the freeside-adduser manpage</A></P>
<P><A HREF="././bin/freeside-bill.html">the freeside-bill manpage</A></P>
<P><A HREF="././bin/freeside-overdue.html">the freeside-overdue manpage</A></P>
<P>
<H2><A NAME="user interface classes (under (stalled) development; not yet usable)">User Interface classes (under (stalled) development; not yet usable)</A></H2>
<P><A HREF="././FS/UI/Base.html">the FS::UI::Base manpage</A> - User-interface base class</P>
<P><A HREF="././FS/UI/Gtk.html">the FS::UI::Gtk manpage</A> - Gtk user-interface class</P>
<P><A HREF="././FS/UI/CGI.html">the FS::UI::CGI manpage</A> - CGI (HTML) user-interface class</P>
<P><A HREF="././FS/UI/agent.html">the FS::UI::agent manpage</A> - agent table user-interface class</P>
<P>
<H2><A NAME="notes">Notes</A></H2>
<P>To quote perl(1), ``If you're intending to read these straight through for the
first time, the suggested order will tend to reduce the number of forward
references.''</P>
<P>If you've never used OO modules before,
<A HREF="http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html">http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html</A> might help you out.</P>
<P>
<HR>
<H1><A NAME="description">DESCRIPTION</A></H1>
<P>Freeside is a billing and administration package for Internet Service
Providers.</P>
<P>The Freeside home page is at <http://www.sisd.com/freeside>.</P>
<P>The main documentation is in httemplate/docs.</P>
<P>
<HR>
<H1><A NAME="support">SUPPORT</A></H1>
<P>A mailing list for users is available. Send a blank message to
<<A HREF="mailto:ivan-freeside-subscribe@sisd.com">ivan-freeside-subscribe@sisd.com</A>> to subscribe.</P>
<P>A mailing list for developers is available. It is intended to be lower volume
and higher SNR than the users list. Send a blank message to
<<A HREF="mailto:ivan-freeside-devel-subscribe@sisd.com">ivan-freeside-devel-subscribe@sisd.com</A>> to subscribe.</P>
<P>Commercial support is available; see
<http://www.sisd.com/freeside/commercial.html>.</P>
<P>
<HR>
<H1><A NAME="author">AUTHOR</A></H1>
<P>Primarily Ivan Kohler <<A HREF="mailto:ivan@sisd.com">ivan@sisd.com</A>>, with help from many kind folks.</P>
<P>See the CREDITS file in the Freeside distribution for a (hopefully) complete
list and the individal files for details.</P>
<P>
<HR>
<H1><A NAME="see also">SEE ALSO</A></H1>
<P>perl(1), main Freeside documentation in htdocs/docs/</P>
<P>
<HR>
<H1><A NAME="bugs">BUGS</A></H1>
<P>Those modules which would be useful separately should be pulled out,
renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH
and Net::SCP...</P>
</BODY>
</HTML>
|
