document using neighbor descriptions to specify neighbors where

applicable.  ok henning, jmc

2 files changed, 16 insertions, 9 deletions

diff --git a/usr.sbin/bgpctl/bgpctl.8 b/usr.sbin/bgpctl/bgpctl.8
index 64db896ee5a..2d8346c4f20 100644
--- a/usr.sbin/bgpctl/bgpctl.8
+++ b/usr.sbin/bgpctl/bgpctl.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: bgpctl.8,v 1.24 2004/10/27 03:35:10 jaredy Exp $
+.\" $OpenBSD: bgpctl.8,v 1.25 2004/12/31 10:47:37 jaredy Exp $
 .\"
 .\" Copyright (c) 2003 Henning Brauer <henning@openbsd.org>
 .\"
@@ -51,12 +51,18 @@ routing table.
 .It Cm fib decouple
 Remove the learned routes from the Forward Information Base a.k.a. the kernel
 routing table.
-.It Cm neighbor Ar address Cm up
+.It Cm neighbor Ar peer Cm up
 Take the BGP session to the specified neighbor up.
-.It Cm neighbor Ar address Cm down
+.Ar peer
+may be the neighbor's address or description.
+.It Cm neighbor Ar peer Cm down
 Take the BGP session to the specified neighbor down.
-.It Cm neighbor Ar address Cm clear
+.Ar peer
+may be the neighbor's address or description.
+.It Cm neighbor Ar peer Cm clear
 Stop and restart the BGP session to the specified neighbor.
+.Ar peer
+may be the neighbor's address or description.
 .It Cm network add Ar prefix
 Add the specified prefix to the list of announced networks.
 .It Cm network delete Ar prefix
@@ -89,9 +95,10 @@ Show only routes required to reach a BGP nexthop.
 .El
 .It Cm show interfaces
 Show the interface states.
-.It Cm show neighbor Ar address modifier
+.It Cm show neighbor Ar peer modifier
 Show detailed information about the neighbor identified by
-.Ar address ,
+.Ar peer ,
+which may be the neighbor's address or description,
 according to the given
 .Ar modifier :
 .Pp
diff --git a/usr.sbin/bgpd/bgpd.conf.5 b/usr.sbin/bgpd/bgpd.conf.5
index a1e8e52ffea..053669f3ce2 100644
--- a/usr.sbin/bgpd/bgpd.conf.5
+++ b/usr.sbin/bgpd/bgpd.conf.5
@@ -1,4 +1,4 @@
-.\" $OpenBSD: bgpd.conf.5,v 1.41 2004/11/19 10:06:33 claudio Exp $
+.\" $OpenBSD: bgpd.conf.5,v 1.42 2004/12/31 10:47:37 jaredy Exp $
 .\"
 .\" Copyright (c) 2004 Claudio Jeker <claudio@openbsd.org>
 .\" Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
@@ -349,8 +349,8 @@ The default for IBGP peers is
 .Pp
 .It Ic descr Ar description
 Add a description.
-The description is used when logging neighbor events and in status
-reports, etc., and has no further meaning to
+The description is used when logging neighbor events, in status
+reports, for specifying neighbors, etc., but has no further meaning to
 .Xr bgpd 8 .
 .Pp
 .It Xo