[doc] document neighbor ..... update-source

2006-05-23 Paul Jakma <paul.jakma@sun.com>

	* bgpd.texi: Document the update-source command.

diff --git a/doc/ChangeLog b/doc/ChangeLog
index 2300a7d540ab91fdcf1af9a112aaae3e89410610..569f8ff3c1a2e6971113e7dac4399400ca877d0e 100644 (file)
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,7 @@
+2006-05-23 Paul Jakma <paul.jakma@sun.com>
+
+       * bgpd.texi: Document the update-source command.
+
 2006-05-10 Paul Jakma <paul.jakma@sun.com>
 
        * quagga.info: update auto-built file.

diff --git a/doc/bgpd.texi b/doc/bgpd.texi
index a9c4810f6a56abbb63f6ee6c8da4926c7fdab045..8c64d78f9b8112e8ab7f58e684d384ea49b0bf92 100644 (file)
--- a/doc/bgpd.texi
+++ b/doc/bgpd.texi
@@ -262,8 +262,13 @@ version.
 
 @deffn {BGP} {neighbor @var{peer} interface @var{ifname}} {}
 @deffnx {BGP} {no neighbor @var{peer} interface @var{ifname}} {}
-When you connect to a BGP peer over an IPv6 link-local address, you have
-to specify the @var{ifname} of the interface used for the connection.
+When you connect to a BGP peer over an IPv6 link-local address, you 
+have to specify the @var{ifname} of the interface used for the 
+connection. To specify IPv4 session addresses, see the 
+@code{neighbor @var{peer} update-source} command below.
+
+This command is deprecated and may be removed in a future release. Its
+use should be avoided.
 @end deffn
 
 @deffn {BGP} {neighbor @var{peer} next-hop-self} {}
@@ -272,8 +277,19 @@ This command specifies an announced route's nexthop as being equivalent
 to the address of the bgp router.
 @end deffn
 
-@deffn {BGP} {neighbor @var{peer} update-source} {}
+@deffn {BGP} {neighbor @var{peer} update-source @var{(ifname|address)}} {}
 @deffnx {BGP} {no neighbor @var{peer} update-source} {}
+Specify the IPv4 source address to use for the @acronym{BGP} session to this
+neighbour, may be specified as either an IPv4 address directly or
+as an interface name (in which case the @command{zebra} daemon MUST be running
+in order for @command{bgpd} to be able to retrieve interface state).
+@example
+@group
+router bgp 64555
+ neighbor foo update-source 192.168.0.1
+ neighbor bar update-source lo0
+@end group
+@end example
 @end deffn
 
 @deffn {BGP} {neighbor @var{peer} default-originate} {}