blob: ab01acf99b4354aa1daca48027528b7c38fd946e (
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
<HTML>
<HEAD>
<TITLE>FS - Freeside Perl modules</TITLE>
<LINK REV="made" HREF="mailto:none">
</HEAD>
<BODY>
<!-- INDEX BEGIN -->
<UL>
<LI><A HREF="#NAME">NAME</A>
<LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
<UL>
<LI><A HREF="#Database_metadata_classes">Database metadata classes</A>
<LI><A HREF="#Utility_classes">Utility classes</A>
<LI><A HREF="#Database_record_classes">Database record classes</A>
<LI><A HREF="#User_Interface_classes_under_de">User Interface classes (under development; not yet usable)</A>
<LI><A HREF="#Notes">Notes</A>
</UL>
<LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
<LI><A HREF="#VERSION">VERSION</A>
<LI><A HREF="#SUPPORT">SUPPORT</A>
<LI><A HREF="#AUTHOR">AUTHOR</A>
<LI><A HREF="#SEE_ALSO">SEE ALSO</A>
<LI><A HREF="#BUGS">BUGS</A>
</UL>
<!-- INDEX END -->
<HR>
<P>
<H1><A NAME="NAME">NAME</A></H1>
<P>
FS - Freeside Perl modules
<P>
<HR>
<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
<P>
FS is the temporary prefix for many disparate modules written for the
Freeside ISP billing software. This includes:
<P>
<HR>
<H2><A NAME="Database_metadata_classes">Database metadata classes</A></H2>
<P>
<A HREF="./FS/dbdef.html">FS::dbdef</A> - Database class
<P>
<A HREF="./FS/dbdef_table.html">FS::dbdef_table</A> - Database table class
<P>
<A HREF="./FS/dbdef_column.html">FS::dbdef_column</A> - Database column class
<P>
<A HREF="./FS/dbdef_colgroup.html">FS::dbdef_colgroup</A> - Database column group class
<P>
<A HREF="./FS/dbdef_index.html">FS::dbdef_index</A> - Database index class
<P>
<A HREF="./FS/dbdef_unique.html">FS::dbdef_unique</A> - Database unique index class
<P>
<HR>
<H2><A NAME="Utility_classes">Utility classes</A></H2>
<P>
<A HREF="./FS/SSH.html">FS::SSH</A> - Simple wrappers around ssh and scp commands.
<P>
<A HREF="./FS/Conf.html">FS::Conf</A> - Freeside configuration values
<P>
<A HREF="./FS/UID.html">FS::UID</A> - User class (not yet OO)
<P>
<A HREF="./FS/CGI.html">FS::CGI</A> - Non OO-subroutines for the web interface. This is depriciated. Future
development will be focused on the FS::UI user-interface classes (see
below).
<P>
<HR>
<H2><A NAME="Database_record_classes">Database record classes</A></H2>
<P>
<A HREF="./FS/Record.html">FS::Record</A> - Database record base class
<P>
<A HREF="./FS/svc_acct_pop.html">FS::svc_acct_pop</A> - POP (Point of Presence, not Post Office Protocol) class
<P>
<A HREF="./FS/part_referral.html">FS::part_referral</A> - Referral class
<P>
<A HREF="./FS/cust_main_county.html">FS::cust_main_county</A> - Locale (tax rate) class
<P>
<A HREF="./FS/svc_Common.html">FS::svc_Common</A> - Service base class
<P>
<A HREF="./FS/svc_acct.html">FS::svc_acct</A> - Account (shell, RADIUS, POP3) class
<P>
<A HREF="./FS/svc_domain.html">FS::svc_domain</A> - Domain class
<P>
<A HREF="./FS/svc_acct_sm.html">FS::svc_acct_sm</A> - Vitual mail alias class
<P>
<A HREF="./FS/part_svc.html">FS::part_svc</A> - Service definition class
<P>
<A HREF="./FS/part_pkg.html">FS::part_pkg</A> - Package (billing item) definition class
<P>
<A HREF="./FS/pkg_svc.html">FS::pkg_svc</A> - Class linking package (billing item) definitions (see <A HREF="./FS/part_pkg.html">FS::part_pkg</A>) with service definitions (see <A HREF="./FS/part_svc.html">FS::part_svc</A>)
<P>
<A HREF="./FS/agent.html">FS::agent</A> - Agent (reseller) class
<P>
<A HREF="./FS/agent_type.html">FS::agent_type</A> - Agent type class
<P>
<A HREF="./FS/type_pkgs.html">FS::type_pkgs</A> - Class linking agent types (see
<A HREF="./FS/agent_type.html">FS::agent_type</A>) with package (billing item) definitions (see <A HREF="./FS/part_pkg.html">FS::part_pkg</A>)
<P>
<A HREF="./FS/cust_svc.html">FS::cust_svc</A> - Service class
<P>
<A HREF="./FS/cust_pkg.html">FS::cust_pkg</A> - Package (billing item) class
<P>
<A HREF="./FS/cust_main.html">FS::cust_main</A> - Customer class
<P>
<A HREF="./FS/cust_main_invoice.html">FS::cust_main_invoice</A> - Invoice destination class
<P>
<A HREF="./FS/cust_bill.html">FS::cust_bill</A> - Invoice class
<P>
<A HREF="./FS/cust_bill_pkg.html">FS::cust_bill_pkg</A> - Invoice line item class
<P>
<A HREF="./FS/cust_pay.html">FS::cust_pay</A> - Payment class
<P>
<A HREF="./FS/cust_credit.html">FS::cust_credit</A> - Credit class
<P>
<A HREF="./FS/cust_refund.html">FS::cust_refund</A> - Refund class
<P>
<A HREF="./FS/cust_pay_batch.html">FS::cust_pay_batch</A> - Credit card transaction queue class
<P>
<HR>
<H2><A NAME="User_Interface_classes_under_de">User Interface classes (under development; not yet usable)</A></H2>
<P>
<A HREF="./FS/UI/Base.html">FS::UI::Base</A> - User-interface base class
<P>
<A HREF="./FS/UI/Gtk.html">FS::UI::Gtk</A> - Gtk user-interface class
<P>
<A HREF="./FS/UI/CGI.html">FS::UI::CGI</A> - CGI (HTML) user-interface class
<P>
<A HREF="./FS/UI/agent.html">FS::UI::agent</A> - agent table user-interface class
<P>
<HR>
<H2><A NAME="Notes">Notes</A></H2>
<P>
To quote <CODE>perl(1),</CODE> ``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>
<HR>
<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
<P>
Freeside is a billing and administration package for Internet Service
Providers.
<P>
The Freeside home page is at <http://www.sisd.com/freeside>.
<P>
The main documentation is in htdocs/docs.
<P>
<HR>
<H1><A NAME="VERSION">VERSION</A></H1>
<P>
$Id: FS.html,v 1.2 2000-03-03 18:22:42 ivan Exp $
<P>
<HR>
<H1><A NAME="SUPPORT">SUPPORT</A></H1>
<P>
A mailing list for users and developers is available. Send a blank message
to <<A
HREF="mailto:ivan-freeside-subscribe@sisd.com">ivan-freeside-subscribe@sisd.com</A>>
to subscribe.
<P>
Commercial support is available; see
<http://www.sisd.com/freeside/commercial.html>.
<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>
See the CREDITS file in the Freeside distribution for a (hopefully)
complete list and the individal files for details.
<P>
<HR>
<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
<P>
<CODE>perl(1),</CODE> main Freeside documentation in htdocs/docs/
<P>
<HR>
<H1><A NAME="BUGS">BUGS</A></H1>
<P>
The version number of the FS Perl extension differs from the version of the
Freeside distribution, which are both different from the CVS version tag
for each file, which appears under the VERSION heading.
<P>
Those modules which would be useful separately should be pulled out,
renamed appropriately and uploaded to CPAN.
</BODY>
</HTML>
|
