2 $FreeBSD: src/share/examples/isdn/README,v 1.7.2.1 2001/08/10 14:59:46 obrien Exp $
3 $DragonFly: src/share/examples/isdn/README,v 1.2 2003/06/17 04:36:57 dillon Exp $
5 --------------------------------------------------------------------------------
10 Version 1.00.00 / May 2001
18 voice: +49 4101 473574
24 The isdn4bsd package is:
26 Copyright (c) 1997, 2001 by Hellmuth Michaelis. All rights reserved.
28 The standard FreeBSD license applies, for details see the file
29 /usr/share/examples/etc/bsd-style-copyright
33 isdn4bsd would not be what it is without
34 the help and support of many people,
39 Vote with your wallet: in case you want to buy new ISDN hardware,
40 buy it from manufacturers who support the development of i4b,
41 for a list of supporters have a look at file ThankYou!
45 This package is postcard-ware:
46 ==============================
48 The (for laywer infected places: optional) license fee for using
49 isdn4bsd is sending a picture postcard of your home town.
50 My address can be found at the top of this file.
53 --------------------------------------------------------------------------------
59 3. Which BSD's are supported ?
60 4. Which ISDN cards are supported ?
61 5. Where do i find documentation for isdn4bsd ?
62 6. How do i install isdn4bsd ?
63 7. Where do i get support for isdn4bsd ?
64 8. Where do i get commercial support for isdn4bsd ?
65 9. How can i help and/or support isdn4bsd ?
66 10. How do i report bugs ?
67 11. Is there a mailing-list available for isdn4bsd ?
68 12. Where can i get isdn4bsd ?
69 13. What is the reward for reading everything in this file ?
75 It may be illegal in your country to connect an isdn4bsd based machine
76 using a passive ISDN card to the ISDN at your site because the protocol
77 stack of isdn4bsd, which is necessary to run passive cards, has not been
78 approved by the telecommunication certification authority of your country.
79 If in doubt, please contact your local ISDN provider !
82 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
83 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
84 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
85 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
86 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
87 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
88 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
89 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
90 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
91 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
98 Isdn4bsd (or in short i4b) is a package for interfacing a computer running
99 FreeBSD, NetBSD, OpenBSD or BSD/OS to the ISDN.
101 The only ISDN protocol currently supported by the drivers for passive cards
102 is the BRI protocol specified in I.430, Q.921 and Q.931; better known as
105 Other ISDN Protocols may be / are supported by the microcode of the supported
108 Isdn4bsd allows you to make IP network connections by using either IP packets
109 sent in raw HDLC frames on the B channel or by using built-in synchronous PPP
110 (or using userland ppp, this is experimental and only available for FreeBSD).
112 For telephony, isdn4bsd can answer incoming phone calls like an answering
113 machine and now has preliminary dialout capabilities for voice and data calls.
116 3. Which BSD's are supported ?
117 ------------------------------
122 FreeBSD-STABLE and FreeBSD-CURRENT is supported
123 by this version of isdn4bsd.
125 I4b was integrated into FreeBSD in January 1999, so it is part
126 of the base FreeBSD system since FreeBSD 3.x.
128 Please take the time to read the available documentation carefully.
133 The NetBSD specific support and the Diehl driver was written by
134 Martin Husemann, (martin@netbsd.org). Isdn4bsd was integrated
135 into the NetBSD tree in January 2001, please have a look at
136 http://www.de.netbsd.org/Documentation/network/isdn/ for more
141 The NetBSD/Amiga specific support was done by Ignatios Souvatzis,
146 The NetBSD/Atari specific support was done by Leo Weppelman,
151 This port is still experimental!
153 The NetBSD/Alpha specific support was done by Jan-Hinrich Fessel,
154 (oskar@zippo.unna.ping.de)
158 Nikolay Sturm (sturm@physik.rwth-aachen.de) sent in patches to
159 support OpenBSD/i386 2.6, they are still experimental and since
160 i don't run OpenBSD i have no idea on the state of affairs.
164 The BSD/OS 4.0 specific support was done by Bert Driehuis. The
165 support is not yet complete. Please contact Bert directly in case
166 of questions regarding this at driehuis@playbeing.org.
169 4. Which ISDN cards are supported ?
170 -----------------------------------
172 For a list of supported ISDN cards, please have a look at
173 the file "SupportedCards".
175 Please have a look at the ReleaseNotes file !
178 5. Where do i find documentation for isdn4bsd ?
179 -----------------------------------------------
181 - in case you are upgrading from previous versions of isdn4bsd, have a
182 look at the ReleaseNotes file in the top level directory for major
183 changes and improvements.
185 - For installation instructions have a look at the isdn4bsd handbook
186 available online at http://people.freebsd.org/~hm/
188 - isdn4bsd has a homepage at http://www.freebsd-support.de/i4b/ where i
189 will try to maintain links to docs, updates and errata.
191 - Every program and every driver has a man page.
192 Hint: try "apropos isdn4bsd", it displays all available manual pages.
194 - The file Overview contains a short technical overview of the inner
195 workings of isdn4bsd.
197 - The file Resources contains URL's and ISBN's to more interesting ISDN
201 6. How do i install isdn4bsd ?
202 ------------------------------
204 Read the installation instructions in the isdn4bsd handbook which is
205 available online at http://people.freebsd.org/~hm/
207 In case they are incomplete, unclear, wrong or outdated, please send me an
208 update for inclusion into a future distribution!
211 7. Where do i get support for isdn4bsd ?
212 ----------------------------------------
214 Please send all questions regarding the installation, configuration
215 and setup of isdn4bsd to the isdn4bsd mailing list (see below).
217 Please do not send me private mail asking for help with the installation,
218 configuration and setup of isdn4bsd: due to the amount of mail of this
219 type i'm no longer able to reply to those mails.
221 Before sending mail asking for help, PLEASE (!) read the supplied
222 documentation, the examples, the handbook, the manual pages and the FAQ !
224 I will support and help with isdn4bsd as my time permits it. Please
225 keep in mind that in this case support is given on a voluntary basis
226 and your questions might not be answered immediately.
228 Also, i strongly recommend subscribing to the mailing list mentioned below.
230 Due to the experience gained supporting the predecessor of isdn4bsd, let
231 me please clearly state that there is no guarantee that your bug will be
232 fixed within some specific amount of time, in fact there is no guarantee
233 that your bug will be fixed at all; i'll do my best but there might be
234 more important things going on in my life than giving free support for
237 Some bugs seem to occur only in certain environments and are not
238 reproduceable here without access to the equipment you are connected
239 to or other equipment like ISDN simulators (which i don't get access to
240 for free): in this case you are the only person being able to trace down
243 There is a web page for i4b at http://www.freebsd-support.de/i4b available
244 where i will put bugfixes, updates and contributions. In particular it has
245 an "errata" page, where you should look in case you have problems with i4b.
248 8. Where do i get commercial support for isdn4bsd ?
249 ----------------------------------------------------
251 In case you want to pay for support, maintenance, enhancements, extensions
252 to isdn4bsd or whatever else you may need, it is possible to hire me for
253 reasonable rates through my employer HCS GmbH; in this case please contact
254 me for details at hm@hcs.de and/or look at http://www.freebsd-support.de
257 9. How can i help and/or support isdn4bsd ?
258 -------------------------------------------
262 I'm open for constructive suggestions, bugreports, fixes, patches,
263 enhancements and comments to improve isdn4bsd.
265 Please send all questions regarding the installation, configuration
266 and setup of isdn4bsd to the isdn4bsd mailing list.
268 Please send flames to /dev/null and/or start writing your own ISDN package.
270 Isdn4bsd is a project on a voluntary basis and writing and supporting
271 communication systems like isdn4bsd costs much money and much time.
273 Any contribution in terms of equipment, cards, documentation, cash
274 and/or daytime payed work on isdn4bsd will be highly appreciated!
276 You can help by not only reporting bugs, but by sending in a patch for
277 the problem together with a bugreport.
279 In case you cannot fix something yourself, please describe your problem
280 as detailed as possible, include information which version of an operating
281 system you are running, which ISDN board you are using, to which kind
282 of ISDN equipment (like the brand of PBX) you are connected etc. etc.
284 In case you want to get a currently unsupported card supported, write a
285 low level driver for it yourself and submit it. In case you can't write
286 it yourself there is a good chance to get it supported if you can donate
287 one of those cards and - if at all possible - docs for it.
290 10. How do i report bugs ?
291 --------------------------
293 Please submit patches ONLY as context diffs (diff -c)!
295 I vastly prefer receiving bug fixes and enhancements that are clearly
296 differentiated. I don't always know what to do with large patches that
297 contain many bugs and enhances folded into the same context diffs.
299 Please keep it to one fix or enhancement per patch!
301 If your change modifies the external interface of an isdn4bsd program,
302 i.e. more config options, command-line switches, new programs, etc.,
303 then please also include patches for the manual pages and documentation.
308 11. Is there a mailing-list available for isdn4bsd ?
309 ---------------------------------------------------
311 There is a mailing list available at
313 freebsd-isdn@freebsd.org
315 The list is maintained by majordomo, so i.e. to subscribe,
316 send a mail with the text
318 subscribe freebsd-isdn
320 in the message body sent to
322 majordomo@freebsd.org
324 This mailing list is NOT (!) FreeBSD specific, everyone is welcome there!
327 12. Where can i get isdn4bsd ?
328 ------------------------------
330 The isdn4bsd package is part of FreeBSD since FreeBSD 3.0-RELEASE so you
331 get isdn4bsd where you can get FreeBSD: http://www.freebsd.org
333 Isdn4bsd has its own homepage at
335 http://www.freebsd-support.de/i4b
339 13. What is the reward for reading everything in this file ?
340 ------------------------------------------------------------