share/examples/isdn/README

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