summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOndrej Zajicek <santiago@crfreenet.org>2009-11-17 15:50:29 +0100
committerOndrej Zajicek <santiago@crfreenet.org>2009-11-17 15:50:29 +0100
commit62aa96caa28180f76c8aff0c49dd21128e396153 (patch)
tree9533f3dfd25768d47bca89ea53626416b6f974d6
parente04555c04545278cfe3aeae85d707b1d78e5abeb (diff)
downloadbird-62aa96caa28180f76c8aff0c49dd21128e396153.tar
bird-62aa96caa28180f76c8aff0c49dd21128e396153.zip
Adds some documentation to the description option.
-rw-r--r--doc/bird.conf.example1
-rw-r--r--doc/bird.sgml4
2 files changed, 5 insertions, 0 deletions
diff --git a/doc/bird.conf.example b/doc/bird.conf.example
index 0a2aac7..6ab03a2 100644
--- a/doc/bird.conf.example
+++ b/doc/bird.conf.example
@@ -162,6 +162,7 @@ protocol static {
#protocol bgp {
# disabled;
+# description "My BGP uplink"
# local as 65000;
# neighbor 62.168.0.130 as 5588;
# multihop 20 via 62.168.0.13;
diff --git a/doc/bird.sgml b/doc/bird.sgml
index 40793ed..b475830 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -307,6 +307,10 @@ to zero to disable it. An empty <cf><m/switch/</cf> is equivalent to <cf/on/
<tag>export <m/filter/</tag> This is similar to the <cf>import</cf> keyword, except that it
works in the direction from the routing table to the protocol. Default: <cf/none/.
+ <tag>description "<m/text/"</tag> This is an optional
+ description of the protocol. It is displayed as a part of the
+ output of 'show route all' command.
+
<tag>table <m/name/</tag> Connect this protocol to a non-default routing table.
</descrip>