]> git.ipfire.org Git - thirdparty/bird.git/blob - README
Added a `What is missing' section.
[thirdparty/bird.git] / README
1 BIRD Internet Routing Daemon 1.0.0
2
3 (c) 1998--2000 Martin Mares <mj@ucw.cz>
4 (c) 1998--2000 Pavel Machek <pavel@ucw.cz>
5 (c) 1998--2000 Ondrej Filip <feela@network.cz>
6
7 ================================================================================
8
9 The BIRD project is an attempt to create a routing daemon running on UNIX-like
10 systems (but not necessarily limited to them) with full support of all modern
11 routing protocols, easy to use configuration interface and powerful route
12 filtering language.
13
14 This software should be considered a beta version. It has undergone extensive
15 testing by the authors, but since it's the first public release, only a limited
16 amount of "real life" experience is known and there still might be problems
17 with operation in unusual environments.
18
19 If you want to help us debugging, enhancing and porting BIRD or just lurk
20 around to see what's going to develop from this strange creature, feel free
21 to subscribe to the BIRD users mailing list (bird-users@bird.network.cz),
22 send subscribes to majordomo at the same machine). Bug reports, suggestions,
23 feature requests (: and code :) are welcome.
24
25 You can download the latest version from ftp://bird.network.cz/pub/bird/
26 and look at the BIRD home page at http://bird.network.cz/.
27
28 BIRD has been developed as a student project at the Faculty of Math
29 and Physics, Charles University, Prague, Czech Republic under supervision
30 of RNDr. Libor Forst <forst@cuni.cz>.
31
32 This program is free software; you can redistribute it and/or modify
33 it under the terms of the GNU General Public License as published by
34 the Free Software Foundation; either version 2 of the License, or
35 (at your option) any later version.
36
37 This program is distributed in the hope that it will be useful,
38 but WITHOUT ANY WARRANTY; without even the implied warranty of
39 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
40 GNU General Public License for more details.
41
42 You should have received a copy of the GNU General Public License
43 along with this program; if not, write to the Free Software
44 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
45
46
47 How to install BIRD:
48
49 ./configure
50 make
51 make install
52 vi /usr/local/etc/bird.conf
53
54 Online documentation is available as HTML files in the doc directory,
55 you can install it by `make install-docs' and rebuild it by `make docs',
56 but for the latter you need SGMLtools and LaTeX to be installed on your
57 machine. You can also download a neatly formatted PostScript version
58 as a separate archive (bird-doc-*.tar.gz).
59
60 What do we support:
61
62 o Both IPv4 and IPv6 (use --enable-ipv6 when configuring)
63 o Multiple routing tables
64 o BGP
65 o RIP
66 o OSPF (IPv4 only)
67 o Static routes
68 o Inter-table protocol
69 o Command-line interface (using the `birdc' client; to get
70 some help, just press `?')
71 o Soft reconfiguration -- no online commands for changing the
72 configuration in very limited ways, just edit the configuration
73 file and issue a `configure' command or send SIGHUP and BIRD
74 will start using the new configuration, possibly restarting
75 protocols affected by the configuration changes.
76 o Powerful language for route filtering (see doc/bird.conf.example).
77
78 What is missing:
79
80 o OSPF for IPv6
81 o OSPF multiple areas and virtual links
82 o See the TODO list
83
84 Good Luck and enjoy the BIRD :)
85 The BIRD Team