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