Initial import from FreeBSD RELENG_4:
[dragonfly.git] / share / examples / isdn / ROADMAP
1
2         Roadmap of isdn4bsd as integrated into FreeBSD
3         ==============================================
4
5  $FreeBSD: src/share/examples/isdn/ROADMAP,v 1.2.2.2 2002/05/22 11:20:39 hm Exp $
6
7         last edit-date: [Tue May 21 13:51:57 2002]
8
9
10 1.      Documentation
11 ---------------------
12
13         The i4b handbook which describes the setup and configuration of
14         isdn4bsd under FreeBSD in detail can be found at 
15         http://people.freebsd.org/~hm/
16
17         The i4b homepage is http://www.freebsd-support.de/i4b/
18
19         The command "apropos isdn" will list all manpages available for 
20         isdn4bsd. Two more manual pages of interest to syncronous PPP 
21         over ISDN users are the pages for sppp and spppcontrol.
22
23         Under directory /usr/share/examples/isdn, you will find:
24
25         FAQ             - isdn4bsd Frequently Asked Questions
26         KERNEL          - kernel config(8) file fragment to add ISDN support
27         Overview        - short technical overview (outdated)
28         README          - the original isdn4bsd README file
29         ROADMAP         - this file
30         ReleaseNotes    - list of major changes 
31         Resources       - where to get more information about ISDN
32         SupportedCards  - list of supported ISDN cards
33         ThankYou        - contributors to isdn4bsd
34
35         contrib         - contributed examples and code
36         v21             - V.21 (300Bd) soft modem emulator
37
38
39 2.      Configuration
40 ---------------------
41
42         Configuration of the isdn4bsd package consists of:
43
44         - configuring a kernel suitable for running isdn4bsd. All
45           kernel configuration statements for isdn4bsd can be found 
46           in the file /usr/src/sys/i386/conf/NOTES - another way to
47           get started is taking the GENERIC configuration file and
48           appending the KERNEL file mentioned above.
49
50         - configuring the network interfaces iprX and/or ispX; the
51           former are used for "IP over raw HDLC" and the latter are
52           used for "sync PPP over ISDN". To configure the ipr-
53           interfaces, read the output of "man i4bipr", to configure
54           the isp-interfaces, read the output of "man i4bisppp",
55           "man sppp" and "man spppcontrol" carefully.
56
57         - writing a configuration file /etc/isdn/isdnd.rc for the
58           isdn daemon isdnd(8) which is responsible for the ISDN
59           call control mechanisms such as: dial on demand, dial
60           retry, dial recovery, timeout and short hold operation.
61           A sample (!) file can be found in /etc/isdn. Please read
62           the output of "man isdnd" and "man isdnd.rc" carefully.
63
64
65 2.      Userland programs
66 -------------------------
67
68         The userland programs can be found in the sourcetree under
69         /usr/src/usr.sbin/i4b and get installed under /usr/sbin.
70
71         Isdntest will not be installed by default.
72         Isdnphone is experimental and may not run with your soundcard.
73
74
75 3.      Kernel part
76 -------------------
77
78         The kernel part of isdn4bsd can be found at /usr/src/sys/i4b.
79
80
81 4.      Answering machine messages
82 ----------------------------------
83
84         Messages to be used by the answering machine can be found in
85         /usr/share/isdn, you'll find the numbers 0 to 9, a beep and
86         a short announcement message here.