summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/bird.conf.example21
-rw-r--r--doc/bird.sgml15
-rw-r--r--doc/reply_codes2
3 files changed, 26 insertions, 12 deletions
diff --git a/doc/bird.conf.example b/doc/bird.conf.example
index 51b2c0e..c710512 100644
--- a/doc/bird.conf.example
+++ b/doc/bird.conf.example
@@ -96,9 +96,9 @@ protocol static {
# honor neighbor; # To whom do we agree to send the routing table
# honor always;
# honor never;
-# passwords { password "ahoj" from 0 to 10;
-# password "nazdar" from 10;
-# }
+# passwords {
+# password "nazdar";
+# };
# authentication none;
# import filter { print "importing"; accept; };
# export filter { print "exporting"; accept; };
@@ -143,6 +143,7 @@ protocol static {
# generate from "22-04-2003 11:00:07";
# accept from "17-01-2003 12:01:05";
# };
+# };
# authentication cryptographic;
# };
# };
@@ -163,7 +164,7 @@ protocol static {
#protocol bgp {
# disabled;
-# description "My BGP uplink"
+# description "My BGP uplink";
# local as 65000;
# neighbor 62.168.0.130 as 5588;
# multihop 20 via 62.168.0.13;
@@ -181,17 +182,17 @@ protocol static {
# default bgp_med 0; # MED value we use for comparison when none is defined
# default bgp_local_pref 0; # The same for local preference
# source address 62.168.0.14; # What local address we use for the TCP connection
-# password "secret" # Password used for MD5 authentication
+# password "secret"; # Password used for MD5 authentication
# rr client; # I am a route reflector and the neighor is my client
-# rr cluster id 1.0.0.1 # Use this value for cluster id instead of my router id
+# rr cluster id 1.0.0.1; # Use this value for cluster id instead of my router id
# export where source=RTS_STATIC;
# export filter {
# if source = RTS_STATIC then {
-## bgp_community = -empty-; bgp_community = add(bgp_community,(65000,5678));
-## bgp_origin = 0;
+# bgp_community = -empty-; bgp_community = add(bgp_community,(65000,5678));
+# bgp_origin = 0;
# bgp_community = -empty-; bgp_community.add((65000,5678));
-## if (65000,5678) ~ bgp_community then
-## bgp_community.add((0, 1));
+# if (65000,5678) ~ bgp_community then
+# bgp_community.add((0, 1));
# if bgp_path ~ [= 65000 =] then
# bgp_path.prepend(65000);
# accept;
diff --git a/doc/bird.sgml b/doc/bird.sgml
index 3d82e45..b70f034 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -824,7 +824,14 @@ defined by using the <cf>defined( <m>attribute</m> )</cf> operator.
Network the route is talking about. Read-only. (See the chapter about routing tables.)
<tag><m/enum/ scope</tag>
- Address scope of the network (<cf/SCOPE_HOST/ for addresses local to this host, <cf/SCOPE_LINK/ for those specific for a physical link, <cf/SCOPE_SITE/ and <cf/SCOPE_ORGANIZATION/ for private addresses, <cf/SCOPE_UNIVERSE/ for globally visible addresses).
+ The scope of the route. Possible values: <cf/SCOPE_HOST/ for
+ routes local to this host, <cf/SCOPE_LINK/ for those specific
+ for a physical link, <cf/SCOPE_SITE/ and
+ <cf/SCOPE_ORGANIZATION/ for private routes and
+ <cf/SCOPE_UNIVERSE/ for globally visible routes. This
+ attribute is not interpreted by BIRD and can be used to mark
+ routes in filters. The default value for new routes is
+ <cf/SCOPE_UNIVERSE/.
<tag><m/int/ preference</tag>
Preference of the route. Valid values are 0-65535. (See the chapter about routing tables.)
@@ -842,7 +849,11 @@ defined by using the <cf>defined( <m>attribute</m> )</cf> operator.
what protocol has told me about this route. Possible values: <cf/RTS_DUMMY/, <cf/RTS_STATIC/, <cf/RTS_INHERIT/, <cf/RTS_DEVICE/, <cf/RTS_STATIC_DEVICE/, <cf/RTS_REDIRECT/, <cf/RTS_RIP/, <cf/RTS_OSPF/, <cf/RTS_OSPF_IA/, <cf/RTS_OSPF_EXT/, <cf/RTS_BGP/, <cf/RTS_PIPE/.
<tag><m/enum/ cast</tag>
- Route type (<cf/RTC_UNICAST/ for normal routes, <cf/RTC_BROADCAST/, <cf/RTC_MULTICAST/, <cf/RTC_ANYCAST/ for broadcast, multicast and anycast routes). Read-only.
+
+ Route type (Currently <cf/RTC_UNICAST/ for normal routes,
+ <cf/RTC_BROADCAST/, <cf/RTC_MULTICAST/, <cf/RTC_ANYCAST/ will
+ be used in the future for broadcast, multicast and anycast
+ routes). Read-only.
<tag><m/enum/ dest</tag>
Type of destination the packets should be sent to (<cf/RTD_ROUTER/ for forwarding to a neighboring router, <cf/RTD_NETWORK/ for routing to a directly-connected network, <cf/RTD_BLACKHOLE/ for packets to be silently discarded, <cf/RTD_UNREACHABLE/, <cf/RTD_PROHIBIT/ for packets that should be returned with ICMP host unreachable / ICMP administratively prohibited messages). Read-only.
diff --git a/doc/reply_codes b/doc/reply_codes
index db760fb..22e0fd2 100644
--- a/doc/reply_codes
+++ b/doc/reply_codes
@@ -24,6 +24,7 @@ Reply codes of BIRD command-line interface
0013 Status report
0014 Route count
0015 Reloading
+0016 Access restricted
1000 BIRD version
1001 Interface list
@@ -51,6 +52,7 @@ Reply codes of BIRD command-line interface
8004 Stopped due to reconfiguration
8005 Protocol is down => cannot dump
8006 Reload failed
+8007 Access denied
9000 Command too long
9001 Parse error