diff --git a/README b/README new file mode 100644 index 00000000..426d46e3 --- /dev/null +++ b/README @@ -0,0 +1,77 @@ + BIRD Internet Routing Daemon 0.0.0 + + (c) 1998--2000 Martin Mares + (c) 1998--2000 Pavel Machek + (c) 1998--2000 Ondrej Filip + +================================================================================ + +The BIRD project is an attempt to create a routing daemon running on UNIX-like +systems (but not necessarily limited to them) with full support of all modern +routing protocols, easy to use configuration interface and powerful route +filtering language. + +BIG FAT WARNING: This is still a development version which probably has lots +of bugs and missing features (including documentation); see below for what is +implemented and what still isn't. + +Welcome to our alpha test team! If you want to help us debugging, enhancing +and porting BIRD or just lurking around to see what's going to develop from +this strange creature, feel free to subscribe to the BIRD users mailing +list (bird-users@atrey.karlin.mff.cuni.cz, send subscribes to majordomo +at the same machine). Bug reports, suggestions, feature requests (: and +code :) are welcome. + +BIRD has been developed as a student project at the Faculty of Math +and Physics, Charles University, Prague, Czech Republic under supervision +of RNDr. Libor Forst . + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +How to install BIRD: + + ./configure + make + make install + vi /usr/local/etc/bird.conf + +What do we support: + + o Both IPv4 and IPv6 (use --enable-ipv6 when configuring) + o Multiple routing tables + o BGP + o RIP + o Partial implementation of OSPF (IPv4 only; soon to be + functional). + o Static routes + o Inter-table protocol + o Command-line interface (using the `birdc' client; to get + some help, just press `?') + o Soft reconfiguration -- no online commands for changing the + configuration in very limited ways, just edit the configuration + file and issue a `configure' command or send SIGHUP and BIRD + will start using the new configuration, possibly restarting + protocols affected by the configuration changes. + o Powerful language for route filtering (see doc/bird.conf.example). + +Missing (see also the TODO file): + + o Rest of OSPF + o Documentation + + +Good Luck and enjoy the BIRD :) + The BIRD Team diff --git a/TODO b/TODO index a5816d91..f829e831 100644 --- a/TODO +++ b/TODO @@ -1,16 +1,12 @@ Core ~~~~ - config: when parsing prefix, check zero bits +- config: try to unify expressions - static: check validity of route destination? -- static: allow specifying a per-route filter program for setting route attributes? - configure: default CFLAGS? -- daemonization - -- netlink: realms - - filters: deletion of mandatory attributes? - filters: user defined attributes? @@ -22,12 +18,17 @@ Core - client: data losses on large dumps? - table: ocassional core dumps in rt_prune() +- table: filtering of old routes during updates? +- table: do feeding by parts - bgp: timing of updates? - bgp: dump and get_route_info +- bgp: when protocol is down, don't print Idle state - proto: Don't show repeated `Changed state to ...' messages if only internal states change +- iface: Don't complain about missing broadcast addresses. + Documentation ~~~~~~~~~~~~~ - write doctool @@ -54,6 +55,8 @@ Globals Various ideas ~~~~~~~~~~~~~ +- static: allow specifying a per-route filter program for setting route attributes? +- netlink: realms - netlink: import Linux route attributes to our rta's, so that they can be filtered? - config: executable config files - client: access control diff --git a/tools/gendist b/tools/gendist new file mode 100755 index 00000000..ee0a6241 --- /dev/null +++ b/tools/gendist @@ -0,0 +1,18 @@ +#!/bin/sh +# +# Generate BIRD Distribution Archive +# (c) 2000 Martin Mares +# + +[ -f Makefile ] && make distclean +autoconf +VERSION=`sed