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